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