aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGravatar Tom Willemsen2013-03-23 21:36:30 +0100
committerGravatar Tom Willemsen2013-03-23 21:36:30 +0100
commit418f7c9d2a88c97a3c90d7f96dd4cbf128ba9c1f (patch)
treeeaae05a3a85167433ebb40095b4446e5dd327ec6
parentaa3f4a26cc0e397fe6cfeb27f3288131eb58d18a (diff)
downloadclark-418f7c9d2a88c97a3c90d7f96dd4cbf128ba9c1f.tar.gz
clark-418f7c9d2a88c97a3c90d7f96dd4cbf128ba9c1f.zip
Update README.org
-rw-r--r--README.org21
1 files changed, 17 insertions, 4 deletions
diff --git a/README.org b/README.org
index 5b54421..2a365ea 100644
--- a/README.org
+++ b/README.org
@@ -24,7 +24,7 @@
* Synopsis
- =clark= <command> [<args> ...]
+ =clark= [options] [<command> [<options> ...]]
* Description
@@ -51,14 +51,27 @@
thing in Common Lisp! So I name it CLark, because it is Common
Lisp, and a rewrite of mARKam.
+* Options
+
+ - =--script= :: Change the output of some commands to be somewhat more
+ machine-friendly, making it easier to parse the data.
+
* Commands
+ - =add= :: Add a new bookmark to the database.
+
+ - =edit= :: Edit a bookmark's information.
+
+ - =exists= :: Check if a bookmark is already present in the database.
+
- =help= :: Prints a usage and help message, showing a list of
possible commands and some hints on how to use them.
- - =version= :: Prints the CLark version and then quits.
-
- - =add= :: Add a new bookmark to the database.
+ - =remove= :: Remove a bookmark from the database.
- =search= :: Search through the database looking for a partial match
on its name or an exact-matching tag.
+
+ - =set-tags= :: Replace or remove a bookmark's tags.
+
+ - =version= :: Prints the CLark version and then quits.