Skip to content

Add manual page and let cmake install it

Caspar Schutijser requested to merge cschutijser/trojita:manual-page into master

I verified on OpenBSD that the manual page is installed in the expected location.

Let me know if you have any suggestions for tweaks to the text, stuff that should be removed or information that can be added.

I choose to mention the organization name "flaska.net" in the FILES section because on IRC we sometimes get questions about the location of the configuration file. This allows people to find it themselves. Perhaps the text could be improved though.

This is what the manpage looks like when it's rendered:

TROJITA(1)		    General Commands Manual		    TROJITA(1)

NAME
     trojita - fast Qt IMAP e-mail client

SYNOPSIS
     trojita [-achlmv] [-p profile] [url]

DESCRIPTION
     trojita is a fast Qt IMAP e-mail client.  Optionally, an RFC2368 mailto
     url may be specified.  This will open the compose window with a message
     constructed from the specified URL.

     trojita supports multiple profiles which allows the use of multiple IMAP
     accounts.	Multiple instances of trojita, each using a different profile,
     may be started concurrently.  A profile may be specified using -p.

     The options are as follows:

     -a, --addressbook
	     Show the addressbook window.

     -c, --compose
	     Compose a new e-mail (default when url is provided).

     -h, --help
	     Show help text.

     -l, --log-to-disk
	     Activate debug traffic logging to disk immediately on startup.

     -m, --mainwindow
	     Show the main window (default when no option is provided).

     -p, --profile profile
	     Use the specified profile.

     -v, --version
	     Show the version of trojita.

FILES
     trojita stores its configuration in a configuration file.	Additionally,
     trojita maintains a cache.	 Where those files are stored is determined by
     Qt.  The organization name of trojita is "flaska.net".  Often, the cache
     and configuration file can be found in a directory named after this
     organization name.

EXAMPLES
     Compose a new e-mail to alice@example.net:

	   $ trojita -c 'mailto:alice@example.net?subject=Hi&body=Message.'

     Launch trojita using a profile:

	   $ trojita -p work

SEE ALSO
     http://trojita.flaska.net/

OpenBSD 7.0		       February 16, 2022		   OpenBSD 7.0

Merge request reports