1
0
mirror of https://github.com/SuperBFG7/ympd synced 2024-11-26 14:57:17 +00:00

updated manpage

This commit is contained in:
Andrew Karpow 2014-03-08 20:37:03 +01:00
parent 6bf4379eb8
commit d4728248f0

28
ympd.1
View File

@ -1,6 +1,6 @@
.\" Manpage for ympd. .\" Manpage for ympd.
.\" Contact andy@ympd.org to correct errors or typos. .\" Contact andy@ympd.org to correct errors or typos.
.TH man 8 "17 Jan 2014" "1.0" "ympd man page" .TH man 8 "08 Mar 2014" "1.2" "ympd man page"
.SH NAME .SH NAME
ympd \- Standalone MPD Web GUI written in C, utilizing Websockets and Bootstrap/JS ympd \- Standalone MPD Web GUI written in C, utilizing Websockets and Bootstrap/JS
.SH SYNOPSIS .SH SYNOPSIS
@ -8,7 +8,7 @@ ympd [OPTION]...
.SH DESCRIPTION .SH DESCRIPTION
ympd is a lightweight MPD (Music Player Daemon) web client that runs without a dedicated werbserver or interpreters like PHP, NodeJS or Ruby. It's tuned for minimal resource usage and requires only very litte dependencies. ympd is a lightweight MPD (Music Player Daemon) web client that runs without a dedicated werbserver or interpreters like PHP, NodeJS or Ruby. It's tuned for minimal resource usage and requires only very litte dependencies.
ympd is based in part on the work of the libwebsockets project (http://libwebsockets.org) ympd is based in part on the work of the mongoose http server (https://github.com/cesanta/mongoose)
.SH OPTIONS .SH OPTIONS
.TP .TP
\fB\-h\fR, \fB\-\-host HOST\fR \fB\-h\fR, \fB\-\-host HOST\fR
@ -17,29 +17,11 @@ connect to mpd at host, defaults to localhost
\fB\-p\fR, \fB\-\-port PORT\fR \fB\-p\fR, \fB\-\-port PORT\fR
connect to mpd at port, defaults to 6600 connect to mpd at port, defaults to 6600
.TP .TP
\fB\-i\fR, \fB\-\-interface INTERFACE\fR
specifies the interface to listen to
.TP
\fB\-w\fR, \fB\-\-webport PORT\fR \fB\-w\fR, \fB\-\-webport PORT\fR
specifies the port for the webserver to listen to, defaults to 8080 specifies the port for the webserver to listen to, defaults to 8080
.TP .TP
\fB\-r\fR, \fB\-\-resourcepath PATH\fR \fB\-u\fR, \fB\-\-user username\fR
resource path to htdocs directory, defaults to the supplied htdocs directory drop privileges to the provided username after socket binding
.TP
\fB\-c\fR, \fB\-\-ssl_cert PATH\fR
path the the ssl certificate
.TP
\fB\-k\fR, \fB\-\-ssl_key PATH\fR
path the the private ssl key
.TP
\fB\-u\fR, \fB\-\-uid UID\fR
drop privileges to the provided uid after socket binding
.TP
\fB\-g\fR, \fB\-\-gid GID\fR
drop privileges to the provided gid after socket binding
.TP
\fB\-v\fR, \fB\-\-verbose [LEVEL]\fR
sets the verbository level
.TP .TP
\fB\-V\fR, \fB\-\-version\fR \fB\-V\fR, \fB\-\-version\fR
print version and exit print version and exit
@ -51,4 +33,4 @@ No known bugs.
.SH AUTHOR .SH AUTHOR
Andrew Karpow (andy@ympd.org) Andrew Karpow (andy@ympd.org)
http://ympd.org https://www.ympd.org