Skip to content

Commit

Permalink
Add roontui man page
Browse files Browse the repository at this point in the history
  • Loading branch information
ron.record committed May 20, 2024
1 parent ecb20b9 commit 5795ddf
Show file tree
Hide file tree
Showing 2 changed files with 207 additions and 0 deletions.
130 changes: 130 additions & 0 deletions man/man1/roontui.1
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
.\" Automatically generated by Pandoc 2.19.2
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "ROONTUI" "1" "May 20, 2024" "roontui 2.1.2" "User Manual"
.hy
.SH NAME
.PP
roontui - Enable/Disable volume fading in a Roon zone
.SH SYNOPSIS
.PP
\f[B]roontui\f[R] [ \f[B]-b|--binary\f[R] BINARY ] [
\f[B]-c|--config\f[R] CONFIG ] [ \f[B]-i|--ip\f[R] IP ] [
\f[B]-p|--port\f[R] PORT ] [ \f[B]-l|--log\f[R] LOG ] [
\f[B]-v|--verbose\f[R] ] [ \f[B]-u|--no-unicode-symbols\f[R] ] [
\f[B]-U|--upgrade\f[R] ] [ \f[B]-h|--help\f[R] ] [
\f[B]-V|--version\f[R] ]
.SH DESCRIPTION
.PP
The \f[B]roon\f[R] command can be used to install the Roon terminal user
interface (https://github.com/TheAppgineer/roon-tui)
(\f[B]roon-tui\f[R]), a project maintained by \f[B]TheAppgineer\f[R]
organization, authors of the Roon Extension
Manager (https://github.com/TheAppgineer/roon-extension-manager).
.PP
Install \f[B]roon-tui\f[R] with the command \f[B]roon -I\f[R] or via the
\f[B]RoonCommandLine\f[R] menu interface.
.PP
The \f[B]RoonCommandLine\f[R] installation of \f[B]roon-tui\f[R]
installs the binary as \f[B]\[ti]/.local/bin/roon-tui\f[R] or
\f[B]/opt/homebrew/bin/roon-tui\f[R] on \f[B]macOS\f[R]
.PP
\f[B]RoonCommandLine\f[R] includes a front-end wrapper for
\f[B]roon-tui\f[R], installed as \f[B]/usr/local/Roon/bin/roontui\f[R]
which serves to locate the \f[B]roon-tui\f[R] configuration file and log
in \f[B]\[ti]/.config/roon-tui/\f[R].
.PP
The \f[B]roon-tui\f[R] terminal user interface for Roon can be executed
either with the wrapper, \f[B]roontui\f[R] or with \f[B]roon -O\f[R].
Executing \f[B]roon-tui\f[R] directly will attempt to use and write the
configuration and log files in the directory where \f[B]roon-tui\f[R] is
located.
Recommended usage is either with \f[B]roontui\f[R] or, if no options are
required, \f[B]roon -O\f[R].
.SH COMMAND LINE OPTIONS
.TP
\f[B]-b, --binary BINARY\f[R]
Path to the roon-tui binary [default binary location:
\f[B]\[ti]/.local/bin/roon-tui\f[R]]
.TP
\f[B]-c, --config CONFIG\f[R]
Path to the config.json file [default configuration location:
\f[B]\[ti]/.config/roon-tui/config.json\f[R]]
.TP
\f[B]-i, --ip IP\f[R]
IP address of the Server, disables server discovery
.TP
\f[B]-p, --port PORT\f[R]
Port number of the Server [default: 9330]
.TP
\f[B]-l, --log LOG\f[R]
Path to the log file [default log file location:
\f[B]\[ti]/.config/roon-tui/roon-tui.log\f[R]]
.TP
\f[B]-v, --verbose\f[R]
Enable verbose logging to file
.TP
\f[B]-u, --no-unicode-symbols\f[R]
Disable the use of Unicode symbols
.TP
\f[B]-U, --upgrade\f[R]
Upgrade roon-tui if a newer version is available and exit
.TP
\f[B]-h, --help\f[R]
Print help
.TP
\f[B]-V, --version\f[R]
Print version
.SH AUTHORS
.PP
Written by Ronald Record <github@ronrecord.com>
.SH LICENSING
.PP
ROONTUI is distributed under an Open Source license.
See the file LICENSE in the ROONTUI source distribution for information
on terms & conditions for accessing and otherwise using ROONTUI and for
a DISCLAIMER OF ALL WARRANTIES.
.PP
The \f[B]roon-tui\f[R] project at
<https://github.com/TheAppgineer/roon-tui> is distributed under the MIT
License and Copyright (c) 2023 The Appgineer.
.SH BUGS
.PP
Submit \f[B]RoonCommandLine\f[R] bug reports online at:
<https://github.com/doctorfree/RoonCommandLine/issues>
.PP
Submit \f[B]roon-tui\f[R] bug reports online at:
<https://github.com/TheAppgineer/roon-tui/issues>
.SH SEE ALSO
.PP
\f[B]roon_fade\f[R](1), \f[B]clone_pyroon\f[R](1),
\f[B]get_core_ip\f[R](1), \f[B]get_zones\f[R](1),
\f[B]list_albums\f[R](1), \f[B]list_artist_albums\f[R](1),
\f[B]list_artists\f[R](1), \f[B]list_composers\f[R](1),
\f[B]list_genre_albums\f[R](1), \f[B]list_genre_artists\f[R](1),
\f[B]list_genres\f[R](1), \f[B]list_playlists\f[R](1),
\f[B]list_radio\f[R](1), \f[B]list_tags\f[R](1),
\f[B]list_zones\f[R](1), \f[B]now_playing\f[R](1),
\f[B]play_album\f[R](1), \f[B]play_artist\f[R](1),
\f[B]play_artist_album\f[R](1), \f[B]play_artist_track\f[R](1),
\f[B]play_composer\f[R](1), \f[B]play_genre\f[R](1),
\f[B]play_genre_album\f[R](1), \f[B]play_genre_artist\f[R](1),
\f[B]play_playlist\f[R](1), \f[B]play_radio\f[R](1),
\f[B]play_tag\f[R](1), \f[B]roon\f[R](1), \f[B]set_zone\f[R](1),
\f[B]set_zone_group\f[R](1), \f[B]zone_command\f[R](1)
.PP
Full documentation and sources at:
<https://github.com/doctorfree/RoonCommandLine>
77 changes: 77 additions & 0 deletions markdown/roontui.1.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: ROONTUI
section: 1
header: User Manual
footer: roontui 2.1.2
date: May 20, 2024
---
# NAME
roontui - Enable/Disable volume fading in a Roon zone

# SYNOPSIS
**roontui** [ **-b|--binary** BINARY ] [ **-c|--config** CONFIG ] [ **-i|--ip** IP ] [ **-p|--port** PORT ] [ **-l|--log** LOG ] [ **-v|--verbose** ] [ **-u|--no-unicode-symbols** ] [ **-U|--upgrade** ] [ **-h|--help** ] [ **-V|--version** ]

# DESCRIPTION
The **roon** command can be used to install the [Roon terminal user interface](https://github.com/TheAppgineer/roon-tui) (**roon-tui**), a project maintained by **TheAppgineer** organization, authors of the [Roon Extension Manager](https://github.com/TheAppgineer/roon-extension-manager).

Install **roon-tui** with the command **roon -I** or via the **RoonCommandLine** menu interface.

The **RoonCommandLine** installation of **roon-tui** installs the binary as **~/.local/bin/roon-tui** or **/opt/homebrew/bin/roon-tui** on **macOS**

**RoonCommandLine** includes a front-end wrapper for **roon-tui**, installed as **/usr/local/Roon/bin/roontui** which serves to locate the **roon-tui** configuration file and log in **~/.config/roon-tui/**.

The **roon-tui** terminal user interface for Roon can be executed either with the wrapper, **roontui** or with **roon -O**. Executing **roon-tui** directly will attempt to use and write the configuration and log files in the directory where **roon-tui** is located. Recommended usage is either with **roontui** or, if no options are required, **roon -O**.

# COMMAND LINE OPTIONS
**-b, --binary BINARY**
: Path to the roon-tui binary [default binary location: **~/.local/bin/roon-tui**]

**-c, --config CONFIG**
: Path to the config.json file [default configuration location: **~/.config/roon-tui/config.json**]

**-i, --ip IP**
: IP address of the Server, disables server discovery

**-p, --port PORT**
: Port number of the Server [default: 9330]

**-l, --log LOG**
: Path to the log file [default log file location: **~/.config/roon-tui/roon-tui.log**]

**-v, --verbose**
: Enable verbose logging to file

**-u, --no-unicode-symbols**
: Disable the use of Unicode symbols

**-U, --upgrade**
: Upgrade roon-tui if a newer version is available and exit

**-h, --help**
: Print help

**-V, --version**
: Print version

# AUTHORS
Written by Ronald Record github@ronrecord.com

# LICENSING
ROONTUI is distributed under an Open Source license.
See the file LICENSE in the ROONTUI source distribution
for information on terms &amp; conditions for accessing and
otherwise using ROONTUI and for a DISCLAIMER OF ALL WARRANTIES.

The **roon-tui** project at https://github.com/TheAppgineer/roon-tui
is distributed under the MIT License and Copyright (c) 2023 The Appgineer.

# BUGS
Submit **RoonCommandLine** bug reports online at: https://github.com/doctorfree/RoonCommandLine/issues

Submit **roon-tui** bug reports online at: https://github.com/TheAppgineer/roon-tui/issues

# SEE ALSO
**roon_fade**(1), **clone_pyroon**(1), **get_core_ip**(1), **get_zones**(1), **list_albums**(1), **list_artist_albums**(1), **list_artists**(1), **list_composers**(1), **list_genre_albums**(1), **list_genre_artists**(1), **list_genres**(1), **list_playlists**(1), **list_radio**(1), **list_tags**(1), **list_zones**(1), **now_playing**(1), **play_album**(1), **play_artist**(1), **play_artist_album**(1), **play_artist_track**(1), **play_composer**(1), **play_genre**(1), **play_genre_album**(1), **play_genre_artist**(1), **play_playlist**(1), **play_radio**(1), **play_tag**(1), **roon**(1), **set_zone**(1), **set_zone_group**(1), **zone_command**(1)

Full documentation and sources at: https://github.com/doctorfree/RoonCommandLine

0 comments on commit 5795ddf

Please sign in to comment.