From e0eea506162c159df500587db406ee3b1fa3f911 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Gustav=20S=C3=B6rn=C3=A4s?= Date: Thu, 24 Dec 2020 02:51:00 +0100 Subject: add initial man pages --- documentation/mumctl.1 | 159 +++++++++++++++++++++++++++++++++++++++++++++++ documentation/mumctl.txt | 107 +++++++++++++++++++++++++++++++ documentation/mumd.1 | 88 ++++++++++++++++++++++++++ documentation/mumd.txt | 45 ++++++++++++++ documentation/mumdrc.5 | 87 ++++++++++++++++++++++++++ documentation/mumdrc.txt | 55 ++++++++++++++++ 6 files changed, 541 insertions(+) create mode 100644 documentation/mumctl.1 create mode 100644 documentation/mumctl.txt create mode 100644 documentation/mumd.1 create mode 100644 documentation/mumd.txt create mode 100644 documentation/mumdrc.5 create mode 100644 documentation/mumdrc.txt diff --git a/documentation/mumctl.1 b/documentation/mumctl.1 new file mode 100644 index 0000000..690a598 --- /dev/null +++ b/documentation/mumctl.1 @@ -0,0 +1,159 @@ +'\" t +.\" Title: mumd +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.12 +.\" Date: 2020-12-24 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "MUMCTL" "1" "2020-12-24" "\ \&" "\ \&" +.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" +mumctl \- mumd(1) controller +.SH "SYNOPSIS" +.sp +mumctl [] +.SH "DESCRIPTION" +.sp +mumd is a CLI controller for mumd(1), a client daemon for Mumble, a free and +open source voice chat system. +.SH "OPTIONS" +.sp +\-h, \-\-help +.RS 4 +Prints help information. +.RE +.sp +\-\-version +.RS 4 +Prints version information. +.RE +.sp +Subcommands contain additional options. +.SH "SUBCOMMANDS" +.sp +mumctl channel connect +.RS 4 +Connect to another channel. +.RE +.sp +mumctl channel list +.RS 4 +List all channels in the connected server. +.RE +.sp +mumctl completions [\-\-bash|\-\-fish|\-\-zsh] +.RS 4 +Generate a completion file for the specified shell. +.RE +.sp +mumctl config +.RS 4 +Set a configuration value in the mumd(1) config\-file. +.RE +.sp +mumctl config\-reload +.RS 4 +Force a reload of the configuration file (e.g. after editing it externally. +.RE +.sp +mumctl connect [\-p|\-\-port ] [username] +.RS 4 +Connect to a server on the specified port. The host may be either the name +of a saved server or an IP or a URL (in which case username needs to be passed +as well). +If omitted, the port defaults to 64738. +.RE +.sp +mumctl deafen +.RS 4 +Deafen/undeafen yourself. +.RE +.sp +mumctl disconnect +.RS 4 +Disconnect from the currently connected server. +.RE +.sp +mumctl help +.RS 4 +Show a help message. +.RE +.sp +mumctl server add [\-\-password ] [\-\-port ] [\-\-username ] [] +.RS 4 +Add a saved server configuration. +.RE +.sp +mumctl server config +.RS 4 +Configure a variable in a saved server configuration. +.RE +.sp +mumctl server list +.RS 4 +List all saved servers and how many are connected to them. +.RE +.sp +mumctl server remove +.RS 4 +Remove a saved server. +.RE +.sp +mumctl server rename +.RS 4 +Rename a saved server. +.RE +.sp +mumctl status +.RS 4 +Show the currently conneced channel and server. +.RE +.sp +mumctl user mute +.RS 4 +Mute someone else locally. +.RE +.sp +mumctl volume set +.RS 4 +Set the outgoing volume level. +1.0 is the default. +.RE +.sp +mumctl volume set +.RS 4 +Set the volume of another user\(cqs incoming audio. +1.0 is the default. +.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 +mumd(1), mumdrc(5) \ No newline at end of file diff --git a/documentation/mumctl.txt b/documentation/mumctl.txt new file mode 100644 index 0000000..e571f4e --- /dev/null +++ b/documentation/mumctl.txt @@ -0,0 +1,107 @@ +mumd(1) +======= + +Name +---- + +mumctl - mumd(1) controller + +Synopsis +-------- + +mumctl [] + +Description +----------- + +mumd is a CLI controller for mumd(1), a client daemon for Mumble, a free and +open source voice chat system. + +Options +------- + +-h, --help :: + Prints help information. + +--version :: + Prints version information. + +Subcommands contain additional options. + +Subcommands +----------- + +mumctl channel connect :: + Connect to another channel. + +mumctl channel list :: + List all channels in the connected server. + +mumctl completions [--bash|--fish|--zsh] :: + Generate a completion file for the specified shell. + +mumctl config :: + Set a configuration value in the mumd(1) config-file. + +mumctl config-reload :: + Force a reload of the configuration file (e.g. after editing it externally. + +mumctl connect [-p|--port ] [username] :: + Connect to a server on the specified port. The host may be either the name + of a saved server or an IP or a URL (in which case username needs to be passed + as well). + If omitted, the port defaults to 64738. + +mumctl deafen :: + Deafen/undeafen yourself. + +mumctl disconnect :: + Disconnect from the currently connected server. + +mumctl help :: + Show a help message. + +mumctl server add [--password ] [--port ] [--username ] [] :: + Add a saved server configuration. + +mumctl server config :: + Configure a variable in a saved server configuration. + +mumctl server list :: + List all saved servers and how many are connected to them. + +mumctl server remove :: + Remove a saved server. + +mumctl server rename :: + Rename a saved server. + +mumctl status :: + Show the currently conneced channel and server. + +mumctl user mute :: + Mute someone else locally. + +mumctl volume set :: + Set the outgoing volume level. + 1.0 is the default. + +mumctl volume set :: + Set the volume of another user's incoming audio. + 1.0 is the default. + +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 +-------- + +mumd(1), mumdrc(5) diff --git a/documentation/mumd.1 b/documentation/mumd.1 new file mode 100644 index 0000000..8934497 --- /dev/null +++ b/documentation/mumd.1 @@ -0,0 +1,88 @@ +'\" t +.\" Title: mumd +.\" Author: [see the "AUTHOR(S)" section] +.\" Generator: Asciidoctor 2.0.12 +.\" Date: 2020-12-24 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "MUMD" "1" "2020-12-24" "\ \&" "\ \&" +.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" +mumd \- Mumble client daemon +.SH "SYNOPSIS" +.sp +mumd +.SH "DESCRIPTION" +.sp +mumd is a client daemon for Mumble, a free and open source voice chat system. +It is controlled via a controller like mumctl(1). +.SH "FILES" +.sp +Configuration is stored in and read from +.sp +.RS 4 +.ie n \{\ +\h'-04' 1.\h'+01'\c +.\} +.el \{\ +. sp -1 +. IP " 1." 4.2 +.\} +$XDG_CONFIG_HOME/mumdrc if $XDG_CONFIG_HOME is set, otherwise +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 2.\h'+01'\c +.\} +.el \{\ +. sp -1 +. IP " 2." 4.2 +.\} +$HOME/.config/mumdrc if $HOME is set, otherwise +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04' 3.\h'+01'\c +.\} +.el \{\ +. sp -1 +. IP " 3." 4.2 +.\} +/etc/mumdrc. +.RE +.sp +See mumdrc(5) for information about the configuration file. +.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), mumdrc(5) \ No newline at end of file diff --git a/documentation/mumd.txt b/documentation/mumd.txt new file mode 100644 index 0000000..5beb275 --- /dev/null +++ b/documentation/mumd.txt @@ -0,0 +1,45 @@ +mumd(1) +======= + +Name +---- + +mumd - Mumble client daemon + +Synopsis +-------- + +mumd + +Description +----------- + +mumd is a client daemon for Mumble, a free and open source voice chat system. +It is controlled via a controller like mumctl(1). + +Files +----- + +Configuration is stored in and read from + +1. $XDG_CONFIG_HOME/mumdrc if $XDG_CONFIG_HOME is set, otherwise +2. $HOME/.config/mumdrc if $HOME is set, otherwise +3. /etc/mumdrc. + +See mumdrc(5) for information about the configuration file. + +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), mumdrc(5) diff --git a/documentation/mumdrc.5 b/documentation/mumdrc.5 new file mode 100644 index 0000000..e50d203 --- /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-24 +.\" Manual: \ \& +.\" Source: \ \& +.\" Language: English +.\" +.TH "MUMDRC" "5" "2020-12-24" "\ \&" "\ \&" +.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 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) -- cgit v1.2.1