add man page

doc/memo.1

@@ -0,0 +1,86 @@
+.\" Text automatically generated by txt2man
+.TH memo 1 "19 June 2017" "doc" "Linux Reference Manual"
+.SH NAME
+\fBmemo
+\fB
+.SH SYNOPSIS
+.nf
+.fam C
+\fBmemo\fP <command> [\fIarguments\fP]
+
+.fam T
+.fi
+.fam T
+.fi
+.SH DESCRIPTION
+A tool to memorize stuff.
+It saves files $MEMO_DIR ($HOME/\fBmemo\fP by default).
+The structure is $MEMO_DIR/<topic>/memo.md
+You can also copy files in the topic folder as well.
+.PP
+We call the folder $MEMO_DIR/<topic> a 'topic folder'.
+.RE
+.PP
+
+.SH COMMANDS
+.TP
+.B
+add <topic> [text]
+adds text to the memo.md in the topic folder.
+if text is not given it will read from stdin.
+.TP
+.B
+copy <topic> <file-to-copy>
+copy a file to the topic folder.
+.TP
+.B
+search <term-to-search>
+search for a term in $MEMO_DIR using ack.
+.TP
+.B
+show <topic>
+shows memo.md in the topic folder.
+also showes a list of all files in the topic folder
+.TP
+.B
+list
+prints a list of all topics.
+.RE
+.PP
+
+.SH CONFIGURATION
+
+.TP
+.B
+$MEMO_DIR
+holds the folder where to store the \fBmemo\fP files.
+Default is $HOME/\fBmemo\fP
+.SH EXAMPLE
+
+
+Append the string "A search-engine" to the memo.md file
+in the topic "google".
+.PP
+.nf
+.fam C
+    $> memo add google A search-engine
+
+.fam T
+.fi
+Appends the content of "www.google.com" to the memo.md file
+the topic "google".
+.PP
+.nf
+.fam C
+    $> curl www.google.com | memo add google
+
+.fam T
+.fi
+Copy the "Invoice.pdf" file to the "lawsuit" topic.
+.PP
+.nf
+.fam C
+    $> memo copy lawsuit ~/Downloads/Invoice.pdf
+
+
+

doc/memo.txt

@@ -0,0 +1,53 @@
+NAME
+  memo
+
+SYNOPSIS
+  memo <command> [arguments]
+
+DESCRIPTION
+  A tool to memorize stuff.
+  It saves files $MEMO_DIR ($HOME/memo by default).
+  The structure is $MEMO_DIR/<topic>/memo.md
+  You can also copy files in the topic folder as well.
+
+  We call the folder $MEMO_DIR/<topic> a 'topic folder'.
+
+
+COMMANDS
+  add <topic> [text]      adds text to the memo.md in the topic folder.
+                          if text is not given it will read from stdin.
+
+  copy <topic> <file-to-copy>     copy a file to the topic folder.
+
+  search <term-to-search>         search for a term in $MEMO_DIR using ack.
+
+  show <topic>    shows memo.md in the topic folder.
+                  also showes a list of all files in the topic folder
+
+  list            prints a list of all topics.
+
+
+CONFIGURATION
+
+  $MEMO_DIR   holds the folder where to store the memo files.
+                Default is $HOME/memo
+
+EXAMPLE
+
+
+  Append the string "A search-engine" to the memo.md file
+  in the topic "google".
+
+    $> memo add google A search-engine
+
+  Appends the content of "www.google.com" to the memo.md file
+  the topic "google".
+
+    $> curl www.google.com | memo add google
+
+  Copy the "Invoice.pdf" file to the "lawsuit" topic.
+
+    $> memo copy lawsuit ~/Downloads/Invoice.pdf
+
+
+