68 lines
1.6 KiB
Plaintext
68 lines
1.6 KiB
Plaintext
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.
|
|
|
|
rm <topic> remove $MEMO_DIR/topic folder with all it's content.
|
|
|
|
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
|
|
|
|
edit <topic> opens your favorite editor to edit the memo topic
|
|
|
|
list prints a list of all topics.
|
|
|
|
git <command> run git command in $MEMO_DIR.
|
|
Once $MEMO_DIR is a git repository all memo commands create commits.
|
|
|
|
|
|
|
|
CONFIGURATION
|
|
|
|
$MEMO_DIR holds the folder where to store the memo files.
|
|
Default is $HOME/memo
|
|
|
|
$EDITOR Your favorite editor. Must be set for the edit command
|
|
|
|
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
|
|
|
|
Make $MEMO_DIR a git repository.
|
|
|
|
$> memo git init
|
|
|
|
|
|
|