Rename linkwave to markam

1 files changed, 106 insertions, 0 deletions

diff --git a/doc/markam.texi b/doc/markam.texi
new file mode 100644
index 0000000..3093f8d
--- /dev/null
+++ b/doc/markam.texi
@@ -0,0 +1,106 @@
+\input texinfo   @c -*-texinfo-*-
+@c %**start of header
+@setfilename markam.info
+@settitle markam User Manual
+@c %**end of header
+@copying
+The user manual for markam.
+
+Copyright @copyright{} 2012  Tom Willemsen
+
+@quotation
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.3
+or any later version published by the Free Software Foundation;
+with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
+A copy of the license is included in the section entitled ``GNU
+Free Documentation License''.
+
+A copy of the license is also available from the Free Software
+Foundation Web site at @url{http://www.gnu.org/licenses/fdl.html}.
+
+@end quotation
+
+The document was typeset with
+@uref{http://www.texinfo.org/, GNU Texinfo}.
+
+@end copying
+
+@titlepage
+@title markam User Manual
+@subtitle The user manual for markam
+@author Tom Willemsen <tom@ryuslash.org>
+@page
+@vskip 0pt plus 1filll
+@insertcopying
+@end titlepage
+
+@c Output the table of the contents at the beginning.
+@contents
+
+@ifnottex
+@node Top, Usage, (dir), (dir)
+@top markam User Manual
+
+@insertcopying
+@end ifnottex
+
+@c Generate the nodes for this menu with `C-c C-u C-m'.
+@menu
+* Usage::                       How to use markam
+* Copying This Manual::
+* Index::
+@end menu
+
+@c Update all node entries with `C-c C-u C-n'.
+@c Insert new nodes with `C-c C-c n'.
+@node Usage, Copying This Manual, Top, Top
+@chapter How to use
+
+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:
+
+@example
+markam
+@end example
+
+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:
+
+@example
+markam http://example.org Example \
+       "Some description about Example" \
+       example some more tags
+@end example
+
+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
+following the description will be considered tags.
+
+For the moment markam is rather stupid, assuming that all URLs start
+with @code{http://} or @code{https://}, so other bookmarks can't be
+added (yet).
+
+@node Copying This Manual, Index, Usage, Top
+@appendix Copying This Manual
+
+@menu
+* GNU Free Documentation License::  License for copying this manual.
+@end menu
+
+@c Get fdl.texi from http://www.gnu.org/licenses/fdl.html
+@node GNU Free Documentation License,  , Copying This Manual, Copying This Manual
+@appendixsec
+@include fdl.texi
+
+@node Index,  , Copying This Manual, Top
+@unnumbered Index
+
+@printindex cp
+
+@bye
+
+@c markam.texi ends here