Add man page

man/himalaya.1

@@ -0,0 +1,159 @@
+.\" Automatically generated by Pandoc 2.19.2
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.TH "himalaya" "1" "" "Version 0.6.1" "CLI email management"
+.hy
+.SH NAME
+.PP
+\f[B]himalaya\f[R] \[em] Command-line interface for email management.
+.SH SYNOPSIS
+.PP
+\f[B]himalaya\f[R] [OPTIONS] [SUBCOMMAND]
+.SH DESCRIPTION
+.PP
+Command-line interface for email management.
+.SS Options
+.TP
+-h, --help
+Prints brief usage information.
+.TP
+-a, --account \f[I]string\f[R]
+Selects a specific account.
+.TP
+-c, --config \f[I]path\f[R]
+Forces a specific config file path.
+.TP
+-l, --log-level \f[I]level\f[R]
+Defines the logs level \f[I]default: info\f[R].
+.RS
+.PP
+Possible values: \f[I]error\f[R], \f[I]warn\f[R], \f[I]info\f[R],
+\f[I]debug\f[R], \f[I]trace\f[R].
+.RE
+.TP
+-o, --output \f[I]fmt\f[R]
+Defines the output format \f[I]default: plain\f[R]
+.RS
+.PP
+Possible values: \f[I]plain\f[R], \f[I]json\f[R]
+.RE
+.TP
+-f, --folder \f[I]source\f[R]
+Specifies the source folder \f[I]default: inbox\f[R]
+.TP
+-v, --version
+Prints the current version number.
+.SH SUBCOMMANDS
+.TP
+\f[I]accounts\f[R]
+Lists accounts
+.TP
+\f[I]attachments\f[R]
+Downloads all attachments of the targeted email
+.TP
+\f[I]completion\f[R]
+Generates the completion script for the given shell
+.TP
+\f[I]copy\f[R]
+Copies an email to the targeted folder
+.TP
+\f[I]delete\f[R]
+Deletes an email
+.TP
+\f[I]flag\f[R]
+Handles email flags
+.TP
+\f[I]folders\f[R]
+Lists folders
+.TP
+\f[I]forward\f[R]
+Forwards an email
+.TP
+\f[I]help\f[R]
+Prints this message or the help of the given subcommand(s)
+.TP
+\f[I]list\f[R]
+Lists all emails
+.TP
+\f[I]move\f[R]
+Moves an email to the targeted folder
+.TP
+\f[I]notify\f[R]
+Notifies when new messages arrive in the given folder
+.TP
+\f[I]read\f[R]
+Reads text bodies of an email
+.TP
+\f[I]reply\f[R]
+Answers to an email
+.TP
+\f[I]save\f[R]
+Saves a raw email
+.TP
+\f[I]search\f[R]
+Lists emails matching the given query
+.TP
+\f[I]send\f[R]
+Sends a raw email
+.TP
+\f[I]sort\f[R]
+Sorts emails by the given criteria and matching the given query
+.TP
+\f[I]template\f[R]
+Handles email templates
+.TP
+\f[I]watch\f[R]
+Watches IMAP server changes
+.TP
+\f[I]write\f[R]
+Writes a new email
+.SH CONFIGURATION
+.PP
+The configuration file is located at:
+\f[B]\[ti]/.config/himalaya/config.toml\f[R].
+An example might look like:
+.IP
+.nf
+\f[C]
+display-name = \[dq]Test\[dq]
+downloads-dir = \[dq]\[ti]/downloads\[dq]
+signature = \[dq]Regards,\[dq]
+
+[gmail]
+default = true
+email = \[dq]test\[at]gmail.com\[dq]
+
+backend = \[dq]imap\[dq] # imap, maildir or notmuch
+imap-host = \[dq]imap.gmail.com\[dq]
+imap-port = 993
+imap-login = \[dq]test\[at]gmail.com\[dq]
+imap-passwd-cmd = \[dq]pass show gmail\[dq]
+
+sender = \[dq]smtp\[dq] # smtp or sendmail
+smtp-host = \[dq]smtp.gmail.com\[dq]
+smtp-port = 465
+smtp-login = \[dq]test\[at]gmail.com\[dq]
+smtp-passwd-cmd = \[dq]security find-internet-password -gs gmail -w\[dq]
+\f[R]
+.fi
+.SH BUGS
+.PP
+See GitHub Issues: <https://github.com/soywod/himalaya/issues>
+.SH AUTHOR
+.PP
+himalaya is written by Cl\['e]ment Douin <clement.douin@posteo.net>.
+.PP
+Manpage was contributed by Michael Vetter <jubalh@iodoru.org>.

man/himalaya.1.md

@@ -0,0 +1,178 @@
+% himalaya(1) Version 0.6.1 | CLI email management 
+
+NAME
+====
+
+**himalaya** — Command-line interface for email management.
+
+SYNOPSIS
+========
+
+| **himalaya** \[OPTIONS] \[SUBCOMMAND]
+
+DESCRIPTION
+===========
+
+Command-line interface for email management.
+
+Options
+-------
+
+-h, \--help
+
+:   Prints brief usage information.
+
+-a, \--account _string_
+
+:   Selects a specific account.
+
+-c, \--config _path_
+
+:   Forces a specific config file path.
+
+-l, \--log-level _level_
+
+:   Defines the logs level *default: info*.
+
+    Possible values: *error*, *warn*, *info*, *debug*, *trace*.
+
+-o, \--output _fmt_
+
+:   Defines the output format *default: plain*
+
+    Possible values: *plain*, *json*
+
+-f, \--folder _source_
+
+:   Specifies the source folder *default: inbox*
+
+-v, \--version
+
+:   Prints the current version number.
+
+SUBCOMMANDS
+=====
+
+*accounts*
+
+:   Lists accounts
+
+*attachments*
+
+:   Downloads all attachments of the targeted email
+
+*completion*
+
+:   Generates the completion script for the given shell
+
+*copy*
+
+:   Copies an email to the targeted folder
+
+*delete*
+
+:   Deletes an email
+
+*flag*
+:   Handles email flags
+
+*folders*
+
+:   Lists folders
+
+*forward*
+
+:   Forwards an email
+
+*help*
+
+:   Prints this message or the help of the given subcommand(s)
+
+*list*
+
+:   Lists all emails
+
+*move*
+
+:   Moves an email to the targeted folder
+
+*notify*
+
+:   Notifies when new messages arrive in the given folder
+
+*read*
+
+:   Reads text bodies of an email
+
+*reply*
+
+:   Answers to an email
+
+*save*
+
+:   Saves a raw email
+
+*search*
+
+:   Lists emails matching the given query
+
+*send*
+
+:   Sends a raw email
+
+*sort*
+
+:   Sorts emails by the given criteria and matching the given query
+
+*template*
+
+:   Handles email templates
+
+*watch*
+
+:   Watches IMAP server changes
+
+*write*
+
+:   Writes a new email
+
+
+CONFIGURATION
+===========
+
+The configuration file is located at: **~/.config/himalaya/config.toml**.
+An example might look like:
+
+```
+display-name = "Test"
+downloads-dir = "~/downloads"
+signature = "Regards,"
+
+[gmail]
+default = true
+email = "test@gmail.com"
+
+backend = "imap" # imap, maildir or notmuch
+imap-host = "imap.gmail.com"
+imap-port = 993
+imap-login = "test@gmail.com"
+imap-passwd-cmd = "pass show gmail"
+
+sender = "smtp" # smtp or sendmail
+smtp-host = "smtp.gmail.com"
+smtp-port = 465
+smtp-login = "test@gmail.com"
+smtp-passwd-cmd = "security find-internet-password -gs gmail -w"
+```
+
+BUGS
+====
+
+See GitHub Issues: <https://github.com/soywod/himalaya/issues>
+
+AUTHOR
+======
+
+himalaya is written by Clément Douin <clement.douin@posteo.net>.
+
+Manpage was contributed by Michael Vetter <jubalh@iodoru.org>.