Add manual pages (#88)

docs/example_config.json

@@ -0,0 +1,32 @@
+{
+	"default_profile": "default",
+	"profiles": {
+		"default": {
+			"user_id":  "",
+			"url":      "https://matrix.org",
+			"settings": {},
+			"dirs":     {}
+		}
+	},
+	"settings": {
+		"log_level":                  "warn",
+		"reaction_display":           true,
+		"reaction_shortcode_display": false,
+		"read_receipt_send":          true,
+		"read_receipt_display":       true,
+		"request_timeout":            10000,
+		"typing_notice_send":         true,
+		"typing_notice_display":      true,
+		"users": {
+			"@user:matrix.org": {
+				"name":  "John Doe",
+				"color": "magenta"
+			}
+		},
+		"default_room": "#iamb-users:0x.badd.cafe"
+	},
+	"dirs": {
+		"cache":     "~/.cache/iamb/",
+		"logs":      "~/.local/share/iamb/logs/",
+		"downloads": "~/Downloads/"
+	}

docs/iamb.1.md

@@ -0,0 +1,29 @@
+# NAME
+
+iamb – a terminal-based client for Matrix for the Vim addict
+
+# SYNOPSIS
+
+**iamb** [**--profile** _profile_] [**--config-directory** _directory_] [**--help** | **--version**]
+
+# OPTIONS
+
+These options are primitives at the top-level of the file.
+
+**--profile**, **-P**
+> The profile to start with. Overrides **default_profile** from **iamb(5)**.
+
+**--config-directory**, **-C**
+> Path to the directory the configuration file is located in.
+
+**--help**, **-h**
+> Show a short help text and quit.
+
+**--version**, **-V**
+> Show the iamb version and quit.
+
+# SEE ALSO
+
+**iamb(5)**
+
+Full documentation is available online at \<https://iamb.chat\>

docs/iamb.5.md

@@ -0,0 +1,113 @@
+# NAME
+
+config.json – configuration file for iamb
+
+# SYNOPSIS
+
+Configuration must be placed under _~/.config/iamb/_ and is named config.json.
+
+Example configuration usually comes bundled with your installation and can
+typically be found in _/usr/share/iamb_.
+
+As implied by the filename, the configuration is formatted in JSON. It's
+structure and fields are described below.
+
+# BASIC SETTINGS
+
+These options are primitives at the top-level of the file.
+
+**default_profile** (type: string)
+> The default profile to connect to, unless overwritten by a commandline
+> switch. It has to be defined in the *PROFILES* section.
+
+# PROFILES
+
+These options are configured as a map under the profiles name.
+
+**user_id** (type: string)
+> The user ID to use when connecting to the server. For example "user" for
+> "@user:matrix.org".
+
+**url** (type: string)
+> The URL of the users server. For example "https://matrix.org" for
+> "@user:matrix.org".
+
+**settings** (type: settings object)
+> Overwrite general settings for this account. The fields are identical to
+> those in *TUNABLES*.
+
+**dirs** (type: XDG overrides object)
+> Overwrite general settings for this account. The fields are identical to
+> those in *DIRECTORIES*.
+
+# TUNABLES
+
+These options are configured as a map under the *settings* key and can be
+overridden as described in *PROFILES*.
+
+**log_level** (type: string)
+> Specifies the lowest log level that should be shown. Possible values
+> are: _trace_, _debug_, _info_, _warn_, and _error_.
+
+**reaction_display** (type: boolean)
+> Defines whether or not reactions should be shown.
+
+**reaction_shortcode_display** (type: boolean)
+> Defines whether or not reactions should be shown as their respective
+> shortcode.
+
+**read_receipt_send** (type: boolean)
+> Defines whether or not read confirmations are sent.
+
+**read_receipt_display** (type: boolean)
+> Defines whether or not read confirmations are displayed.
+
+**request_timeout** (type: uint64)
+> Defines the maximum time per request in seconds.
+
+**typing_notice_send** (type: boolean)
+> Defines whether or not the typing state is sent.
+
+**typing_notice_display** (type: boolean)
+> Defines whether or not the typing state is displayed.
+
+**user** (type: map)
+> Overrides values for the specified user. See *USER OVERRIDES* for
+> details on the format.
+
+**default_room** (type: string)
+> The room to show by default instead of a welcome-screen.
+
+## USER OVERRIDES
+
+Overrides are mapped onto matrix User IDs such as _@user:matrix.org_ and are
+maps containing the following key value pairs.
+
+**name** (type: string)
+> Change the display name of the user.
+
+**color** (type: string)
+> Change the color the user is shown as. Possible values are: _black_,
+> _blue_, _cyan_, _dark-gray_, _gray_, _green_, _light-blue_,
+> _light-cyan_, _light-green_, _light-magenta_, _light-red_,
+> _light-yellow_, _magenta_, _none_, _red_, _white_, _yellow_
+
+# DIRECTORIES
+
+Specifies the directories to save data in. Configured as a map under the key
+*dirs*.
+
+**cache** (type: string)
+> Specifies where to store assets and temporary data in.
+
+**logs** (type: string)
+> Specifies where to store log files.
+
+**downloads** (type: string)
+> Specifies where to store downloaded files.
+
+# SEE ALSO
+
+*iamb(1)*
+
+Full documentation is available online at \<https://iamb.chat\>