summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars-Dominik Braun <PromyLOPh@gmail.com>2008-06-15 22:03:37 +0200
committerLars-Dominik Braun <PromyLOPh@gmail.com>2008-06-15 22:03:37 +0200
commit852e19a64893fe3109a42719782c3099ec6ce3d5 (patch)
tree0d86fe1ecd0f2572c8549491a3cb620edd03e292
parent5a3c68a6d13464be6330aa4a5a32ec6115cedef0 (diff)
downloadpianobar-windows-852e19a64893fe3109a42719782c3099ec6ce3d5.tar.gz
pianobar-windows-852e19a64893fe3109a42719782c3099ec6ce3d5.tar.bz2
pianobar-windows-852e19a64893fe3109a42719782c3099ec6ce3d5.zip
client: Manpage added
-rw-r--r--src/Makefile.am2
-rw-r--r--src/pianobar.143
2 files changed, 44 insertions, 1 deletions
diff --git a/src/Makefile.am b/src/Makefile.am
index 1a8f3cf..dd687d7 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -3,4 +3,4 @@ bin_PROGRAMS = pianobar
pianobar_SOURCES = main.c terminal.c terminal.h settings.c settings.h
pianobar_CPPFLAGS = ${LIBCURL_CFLAGS} ${LIBAO_CFLAGS} ${LIBXML_CFLAGS} -I../libpiano
pianobar_LDADD = ${LIBCURL_LIBS} ${LIBAO_LIBS} ${LIBFAAD_LIBS} ${LIBREADLINE_LIBS} ${LIBXML_LIBS} -lpthread ../libpiano/libpiano.la
-
+dist_man1_MANS = pianobar.1
diff --git a/src/pianobar.1 b/src/pianobar.1
new file mode 100644
index 0000000..3d00a53
--- /dev/null
+++ b/src/pianobar.1
@@ -0,0 +1,43 @@
+.TH pianobar 1
+
+.SH NAME
+pianobar \- console pandora.com music player
+
+.SH SYNOPSIS
+.B pianobar
+
+.SH DESCRIPTION
+.B pianobar
+is a lightweight console music player for the personalized online radio
+pandora.com. Currently
+.B pianobar
+is alpha stage software and neither stable nor complete.
+
+.SH FILES
+.I $XDG_CONFIG_HOME/pianobar/config
+or
+.I ~/.config/pianobar/config
+.RS
+Per-user configuration file. See
+.B CONFIGURATION.
+
+.SH CONFIGURATION
+The configuration file consists of simple
+.B key = value
+lines. Each terminated with a newline (\\n) character.
+
+.TP
+.B control_proxy = host:port
+Non-american users need a proxy to use pandora.com. Currently this needs to
+be a SOCKS4a proxy like Tor.
+
+.TP
+.B user = your@user.name
+Your pandora.com username.
+
+.TP
+.B password = plaintext_password
+Your pandora.com password. Plain-text.
+
+.SH AUTHOR
+Lars-Dominik Braun <PromyLOPh@gmail.com>