diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/markam.texi | 43 |
1 files changed, 37 insertions, 6 deletions
diff --git a/doc/markam.texi b/doc/markam.texi index 08cb088..21baa03 100644 --- a/doc/markam.texi +++ b/doc/markam.texi @@ -62,21 +62,51 @@ The document was typeset with @node Usage, Copying This Manual, Top, Top @chapter How to use -Markam can be run either as a script, or compiled to a binary. -Compiling to binaries is recommended, but running is a script might be -easier when debugginng/developing. +For the moment markam is a simple program, it has 3 functions. -For the moment markam is a simple program, it has 2 functions. In -order to view a list of all your bookmarks you can use: +@menu +* List:: List all +* Search:: Search +* Add:: Add/Store/Save +@end menu + +@node List, Search, Usage, Usage +@section List all + +In order to view a list of all your bookmarks you can use: @example markam @end example +@noindent This will show the list of all stored bookmarks, showing the URL, name and description. This list is unsorted and unpaged. -The other function is to add a new bookmark, which can be done with: +@node Search, Add, List, Usage +@section Search + +You can also search through your stored bookmarks by using the +@code{search} command: + +@deffn Command search STRING +Search through the database for any bookmarks that either have +@var{string} as a tag or have @var{string} somewhere in its title. +@end deffn + +@noindent +To perform a search for any bookmarks that have ``markam'' as a tag +and also any that have ``markam'' anywhere in their title you should +use: + +@example +markam search markam +@end example + +@node Add, , Search, Usage +@section Add/Store/Save + +The last function is to add a new bookmark, which can be done with: @example markam http://example.org Example \ @@ -84,6 +114,7 @@ markam http://example.org Example \ example some more tags @end example +@noindent This will store the bookmark with the URL of ``http://example.org'', name ``Example'', description ``Some description about Example'' and the tags ``example'', ``some'', ``more'' and ``tags''. Any arguments |