aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/mumdrc.txt
diff options
context:
space:
mode:
authorGustav Sörnäs <gustav@sornas.net>2020-12-24 02:51:00 +0100
committerGustav Sörnäs <gustav@sornas.net>2020-12-24 13:34:31 +0100
commite0eea506162c159df500587db406ee3b1fa3f911 (patch)
tree874cdbecd47aa6367d686aa1228677cd26bfba22 /documentation/mumdrc.txt
parent2902064db5c24ac30cb1a58fd44832b02ee478be (diff)
downloadmum-e0eea506162c159df500587db406ee3b1fa3f911.tar.gz
add initial man pages
Diffstat (limited to 'documentation/mumdrc.txt')
-rw-r--r--documentation/mumdrc.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/documentation/mumdrc.txt b/documentation/mumdrc.txt
new file mode 100644
index 0000000..5365e06
--- /dev/null
+++ b/documentation/mumdrc.txt
@@ -0,0 +1,55 @@
+mumdrc(5)
+=========
+
+Name
+----
+
+mumdrc - mumd configuration file
+
+Description
+-----------
+
+This file contains persistent configuration for mumd(1). It can be written to
+using mumctl(1).
+
+The following configuration values are supported:
+
+audio.input_volume ::
+ Default 1.0.
+
+audio.output_volume ::
+ Default 1.0.
+
+Servers are specified as \[[servers]]-entries and support the following
+variables:
+
+host ::
+ IP or URL of the server.
+
+name ::
+ Custom alias for the server.
+
+port ::
+ The port to connect to. (Optional)
+
+username ::
+ The username to connect with. (Optional)
+
+password ::
+ The password to supply to the server. (Optional)
+
+Authors
+-------
+
+Gustav Sörnäs and Eskil Queseth.
+
+Reporting bugs
+--------------
+
+Please report bugs to the Github repository at https://github.com/sornas/mum/
+or by e-mail to gustav@sornas.net.
+
+See also
+--------
+
+mumctl(1), mumd(1)