From 852e19a64893fe3109a42719782c3099ec6ce3d5 Mon Sep 17 00:00:00 2001 From: Lars-Dominik Braun Date: Sun, 15 Jun 2008 22:03:37 +0200 Subject: client: Manpage added --- src/Makefile.am | 2 +- src/pianobar.1 | 43 +++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 1 deletion(-) create mode 100644 src/pianobar.1 (limited to 'src') 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 -- cgit v1.2.3