aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 11 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4857d22..b590d61 100644
--- a/README.md
+++ b/README.md
@@ -64,9 +64,7 @@ current again that new new session that `cdlog` had allocated on startup. That
new session does not appear in the numbered list of recoverable sessions unless
it has been already persisted by the execution of a directory-changing command.
-* The `cdalias` command is used for defining "cd aliases"; see below.
-
-* The `cdaliases` command lists cd aliases.
+* The `cdalias` command is used for defining or listing "cd aliases"; see below.
* The `cdunalias` command removes a cd alias.
@@ -107,6 +105,16 @@ If the replacement begins with `@` then it is a search. If
the search succeeds, then the result will be used as the alias
value.
+When `cdalias` is invoked with no arguments, it lists all the
+currently defined aliases.
+
+When `cdalias` is invoked with one argument, and that argument
+names an alias, it lists that alias. Otherwise it fails
+with an error message.
+
+The deprecated `cdaliases` command also lists aliases; it
+will disappear in a future version of `cdlog`.
+
## Searches
A search is an arguments which begins with `@`. The rest