Merge pull request #34 from sornas/man

Add man pages

1 files changed, 87 insertions, 0 deletions

diff --git a/documentation/mumdrc.5 b/documentation/mumdrc.5
new file mode 100644
index 0000000..b540f1b
--- /dev/null
+++ b/documentation/mumdrc.5
@@ -0,0 +1,87 @@
+'\" t
+.\"     Title: mumdrc
+.\"    Author: [see the "AUTHOR(S)" section]
+.\" Generator: Asciidoctor 2.0.12
+.\"      Date: 2020-12-25
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "MUMDRC" "5" "2020-12-25" "\ \&" "\ \&"
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.ss \n[.ss] 0
+.nh
+.ad l
+.de URL
+\fI\\$2\fP <\\$1>\\$3
+..
+.als MTO URL
+.if \n[.g] \{\
+.  mso www.tmac
+.  am URL
+.    ad l
+.  .
+.  am MTO
+.    ad l
+.  .
+.  LINKSTYLE blue R < >
+.\}
+.SH "NAME"
+mumdrc \- mumd configuration file
+.SH "DESCRIPTION"
+.sp
+This file contains persistent configuration for mumd(1). It can be written to
+using mumctl(1).
+.sp
+The following configuration values are supported:
+.sp
+audio.input_volume
+.RS 4
+Default 1.0.
+.RE
+.sp
+audio.output_volume
+.RS 4
+Default 1.0.
+.RE
+.sp
+Servers are specified as [[servers]]\-entries and support the following
+variables:
+.sp
+host
+.RS 4
+IP or URL of the server.
+.RE
+.sp
+name
+.RS 4
+Custom alias for the server.
+.RE
+.sp
+port
+.RS 4
+The port to connect to. (Optional)
+.RE
+.sp
+username
+.RS 4
+The username to connect with. (Optional)
+.RE
+.sp
+password
+.RS 4
+The password to supply to the server. (Optional)
+.RE
+.SH "AUTHORS"
+.sp
+Gustav Sörnäs and Eskil Queseth.
+.SH "REPORTING BUGS"
+.sp
+Please report bugs to the Github repository at \c
+.URL "https://github.com/sornas/mum/" ""
+or by e\-mail to \c
+.MTO "gustav\(atsornas.net" "" "."
+.SH "SEE ALSO"
+.sp
+mumctl(1), mumd(1)
\ No newline at end of file