diff --git a/.gitignore b/.gitignore index 57f1248..1377554 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1 @@ *.swp -doc/memo.1 diff --git a/doc/memo.1 b/doc/memo.1 new file mode 100644 index 0000000..cd3a139 --- /dev/null +++ b/doc/memo.1 @@ -0,0 +1,111 @@ +.\" Automatically generated by Pandoc 2.2.1 +.\" +.TH "memo" "1" "10 August 2018" "doc" "Linux Reference Manual" +.hy +.SH NAME +.PP +memo +.SH SYNOPSIS +.PP +\f[C]memo\ \ [arguments]\f[] +.SH DESCRIPTION +.PP +A tool to memorize stuff. +It saves files \f[C]$MEMO_DIR\f[] (\f[C]$HOME/memo\f[] by default). +The structure is \f[C]$MEMO_DIR//memo.md\f[] You can also copy +files in the topic folder as well. +.PP +We call the folder \f[C]$MEMO_DIR/\f[] a `topic folder'. +.SH COMMANDS +.TP +.B \f[C]add\ \ [text]\f[] +Adds text to the \f[C]memo.md\f[] in the topic folder. +If text is not given it will read from stdin. +.RS +.RE +.TP +.B \f[C]rm\ \f[] +Remove \f[C]$MEMO_DIR/topic\f[] folder with all its content. +.RS +.RE +.TP +.B \f[C]copy\ \ \f[] +Copy a file to the topic folder. +.RS +.RE +.TP +.B \f[C]search\ \f[] +Search for a term in \f[C]$MEMO_DIR\f[] using \f[C]ack\f[]. +.RS +.RE +.TP +.B \f[C]show\ \f[] +Shows \f[C]memo.md\f[] in the topic folder. +Also shows a list of all files in the topic folder. +.RS +.RE +.TP +.B \f[C]edit\ \f[] +Opens your favorite editor to edit the memo topic. +.RS +.RE +.TP +.B \f[C]list\f[] +Prints a list of all topics. +.RS +.RE +.TP +.B \f[C]git\ \f[] +Run a git command in \f[C]$MEMO_DIR\f[]. +Once \f[C]$MEMO_DIR\f[] is a git repository, all memo commands create +commits. +.RS +.RE +.SH CONFIGURATION +.TP +.B \f[C]$MEMO_DIR\f[] +holds the folder where to store the memo files. +Default is \f[C]$HOME/memo\f[]. +.RS +.RE +.TP +.B \f[C]$EDITOR\f[] +Your favorite editor. +Must be set for the edit command. +.RS +.RE +.SH EXAMPLE +.PP +Append the string \[lq]A search\-engine\[rq] to the \f[C]memo.md\f[] +file in the topic \[lq]google\[rq]. +.IP +.nf +\f[C] +$\ memo\ add\ google\ A\ search\-engine +\f[] +.fi +.PP +Appends the content of \f[C]www.google.com\f[] to the \f[C]memo.md\f[] +file the topic \[lq]google\[rq]. +.IP +.nf +\f[C] +$\ curl\ www.google.com\ |\ memo\ add\ google +\f[] +.fi +.PP +Copy the \[lq]Invoice.pdf\[rq] file to the \[lq]lawsuit\[rq] topic. +.IP +.nf +\f[C] +$\ memo\ copy\ lawsuit\ ~/Downloads/Invoice.pdf +\f[] +.fi +.PP +Make \f[C]$MEMO_DIR\f[] a git repository. +.IP +.nf +\f[C] +$\ memo\ git\ init +\f[] +.fi