diff options
author | June McEnroe <june@causal.agency> | 2020-01-25 06:38:41 -0500 |
---|---|---|
committer | June McEnroe <june@causal.agency> | 2020-01-25 06:38:41 -0500 |
commit | 4b2a6e380f0405b6adbcc45f1982530f5a182f4e (patch) | |
tree | 11be3bbac95e15684cff34691b8e7ca3bc64d4aa | |
download | notemap-4b2a6e380f0405b6adbcc45f1982530f5a182f4e.tar.gz notemap-4b2a6e380f0405b6adbcc45f1982530f5a182f4e.zip |
Add basic manual page
-rw-r--r-- | notemap.1 | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/notemap.1 b/notemap.1 new file mode 100644 index 0000000..0ca1fcb --- /dev/null +++ b/notemap.1 @@ -0,0 +1,54 @@ +.Dd January 25, 2020 +.Dt NOTEMAP 1 +.Os +. +.Sh NAME +.Nm notemap +.Nd synchronize notes with IMAP +. +.Sh SYNOPSIS +.Nm +.Op Fl adfpsu +.Op Fl m Ar file +.Op Ar +. +.Sh DESCRIPTION +The +.Nm +utility +synchronizes text notes +with an IMAP mailbox. +Files are mapped to IMAP messages +using a map file. +If no files are given as arguments, +all mapped files are synchronized. +. +.Pp +The arguments are as follows: +.Bl -tag -width Ds +.It Fl a +Add notes to the map file. +. +.It Fl d +Remove notes from the map file. +Notes are not deleted from the server. +. +.It Fl f +Force either a push or pull +to overwrite newer notes. +. +.It Fl p +Push local notes to the server. +. +.It Fl m Ar file +Set the location of the map file. +The default is +.Pa .notemap . +. +.It Fl s +Show the status of local and remote notes. +This is the default action. +. +.It Fl u +Pull remote notes from the server. +.El |