113 lines
1.8 KiB
Groff
113 lines
1.8 KiB
Groff
.\" Text automatically generated by txt2man
|
|
.TH memo 1 "10 August 2018" "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
|
|
rm <topic>
|
|
remove $MEMO_DIR/topic folder with all it's content.
|
|
.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
|
|
edit <topic>
|
|
opens your favorite editor to edit the \fBmemo\fP topic
|
|
.TP
|
|
.B
|
|
list
|
|
prints a list of all topics.
|
|
.TP
|
|
.B
|
|
git <command>
|
|
run git command in $MEMO_DIR.
|
|
Once $MEMO_DIR is a git repository all \fBmemo\fP commands create commits.
|
|
.RE
|
|
.PP
|
|
|
|
|
|
.SH CONFIGURATION
|
|
|
|
.TP
|
|
.B
|
|
$MEMO_DIR
|
|
holds the folder where to store the \fBmemo\fP files.
|
|
Default is $HOME/\fBmemo\fP
|
|
.TP
|
|
.B
|
|
$EDITOR
|
|
Your favorite editor. Must be set for the edit command
|
|
.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
|
|
|
|
.fam T
|
|
.fi
|
|
Make $MEMO_DIR a git repository.
|
|
.PP
|
|
.nf
|
|
.fam C
|
|
$> memo git init
|
|
|
|
|
|
|