From: Kalle Wallin <kaw@linux.se>
Date: Wed, 31 Mar 2004 13:53:33 +0000 (+0000)
Subject: Documentation changes for the 0.10.0 realease.
X-Git-Tag: v0.12_alpha1~615
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=0f19ec9cc112f1368ad267388ed07c02ae631076;p=ncmpc.git

Documentation changes for the 0.10.0 realease.


git-svn-id: https://svn.musicpd.org/ncmpc/trunk@555 09075e82-0dd4-0310-85a5-a0d7c8717e4f
---

diff --git a/TODO b/TODO
index 9b0422e..0330019 100644
--- a/TODO
+++ b/TODO
@@ -2,19 +2,22 @@
 client functions
 ----------------------------------------------------------------------------
   * search screen
-  * load/save playlists						
+  * id3 browser
 
 ncurses
 ----------------------------------------------------------------------------
   * customizable keybindings
-  * color support / customizable color                          - done
-  * improve list drawing (faster)
+  * improve list drawing (faster) 
   
 
 other
 ----------------------------------------------------------------------------
-  * find/search function in playlist (like in less '/')		- done
-  * configuration file(s) - keybindings,colors...               - done
   * internationalization - gettext
+  * SIGWINCH handling
+
+
+
+
+
 
 
diff --git a/configure.ac b/configure.ac
index 912767e..b799344 100644
--- a/configure.ac
+++ b/configure.ac
@@ -3,7 +3,7 @@ dnl  $Id: configure.ac,v 1.10 2004/03/18 09:33:43 kalle Exp $
 dnl
 
 AC_INIT(main.c)
-AM_INIT_AUTOMAKE(ncmpc, 0.10.0-svn)
+AM_INIT_AUTOMAKE(ncmpc, 0.10.0)
 
 dnl Check for programs
 AC_PROG_CC
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 37fb0a4..ef22f07 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,4 +1,4 @@
 man_MANS = ncmpc.1
 docdir = $(prefix)/share/doc/$(PACKAGE)
-doc_DATA = ncmpcrc
+doc_DATA = ncmpcrc.sample
 EXTRA_DIST = $(man_MANS) $(doc_DATA)
diff --git a/doc/ncmpc.1 b/doc/ncmpc.1
index 59f391e..a4f752e 100644
--- a/doc/ncmpc.1
+++ b/doc/ncmpc.1
@@ -1,6 +1,6 @@
 .TH "mpc-ncurses" "1" "0.10.0" "Kalle Wallin" ""
 .SH "NAME"
-ncmpc \- ncurses MPD client.
+ncmpc \- curses Music Player Daemon (MPD) client.
 .SH "SYNOPSIS"
 .B ncmpc
 [options]
@@ -16,6 +16,10 @@ options \-\-host and \-\-port.
 
 $ ncmpc \-\-host=musicserver \-\-port=44000
 
+To use a password with mpd, set MPD_HOST to password@host 
+or use the command line option \-\-password. Vales from 
+the command line overrides values from the environment.
+
 Read more about MPD on http://www.musicpd.org
 
 .SH "OPTIONS"
@@ -26,11 +30,14 @@ Display help.
 .B \-V,  \-\-version
 Display version information.
 .TP 
-.B \-k,  \-\-keys
-Display key bindings.
+.B \-c,  \-\-colors
+Enable colors.
+.TP 
+.B \-C,  \-\-no\-colors
+Disable colors.
 .TP 
 .B \-e,  \-\-exit
-Exit on connection errors. The default way is to reconnect.
+Exit on connection errors. The default is to reconnect.
 .TP 
 .B \-h, \-\-host=HOSTNAME
 Specify MPD host.
@@ -38,12 +45,16 @@ Specify MPD host.
 .B \-p, \-\-port=PORT
 Connect to server on PORT.
 .TP 
+.B \-P, \-\-password=PASSWORD
+Connect top MPD with a password.
+.TP 
 Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.
 .SH "KEYS"
-Since ncmpc is under development key bindings may change. 
-View current ncmpc key bindings in the help screen or by running:
+You can view ncmpc's key bindings by pressing F1 (help) when 
+ncmpc is running.
+.SH "CONFIGURATION FILE"
+When ncmpc start it read user setting from ~/.ncmpcrc. A example file ncmpcrc.sample should be provided with ncmpc.
+
 
-$ ncmpc \-\-keys
-  
 .SH "SEE ALSO"
 mpc(1), MPD(1)
diff --git a/doc/ncmpcrc b/doc/ncmpcrc
deleted file mode 100644
index 98d34c6..0000000
--- a/doc/ncmpcrc
+++ /dev/null
@@ -1,39 +0,0 @@
-#
-# Configuration file for ncmpc (~/.ncmpcrc)
-# 
-
-
-#
-# Color configuration
-#
-# colors: black,red,green,yellow,blue,magenta,cyan,white 
-#
-
-# enable/disable colors
-enable_colors = yes
-
-# background color
-#background_color = blue
-
-# text colors
-#title_color    = white
-#line_color     = green
-#list_color     = yellow
-#progress_color = green
-#status_color   = white
-#alert_color    = yellow
-
-
-#
-# Key bindings - NOT IMPLEMENTED
-#
-# key_up = 13
-
-
-#
-# Key names - NOT IMPLEMENTED
-#
-#key_name  13  Enter
-#
-
-
diff --git a/doc/ncmpcrc.sample b/doc/ncmpcrc.sample
new file mode 100644
index 0000000..98d34c6
--- /dev/null
+++ b/doc/ncmpcrc.sample
@@ -0,0 +1,39 @@
+#
+# Configuration file for ncmpc (~/.ncmpcrc)
+# 
+
+
+#
+# Color configuration
+#
+# colors: black,red,green,yellow,blue,magenta,cyan,white 
+#
+
+# enable/disable colors
+enable_colors = yes
+
+# background color
+#background_color = blue
+
+# text colors
+#title_color    = white
+#line_color     = green
+#list_color     = yellow
+#progress_color = green
+#status_color   = white
+#alert_color    = yellow
+
+
+#
+# Key bindings - NOT IMPLEMENTED
+#
+# key_up = 13
+
+
+#
+# Key names - NOT IMPLEMENTED
+#
+#key_name  13  Enter
+#
+
+
diff --git a/options.c b/options.c
index 8556b0f..81f67bd 100644
--- a/options.c
+++ b/options.c
@@ -29,7 +29,7 @@ static struct poptOption optionsTable[] = {
     "Connect to server on port [" DEFAULT_PORT_STR "].", "PORT" },
   { "host",         'h', POPT_ARG_STRING, &mpd_host, 0, 
     "Connect to server [" DEFAULT_HOST "].", "HOSTNAME" },
-  { "passwd",       'P', POPT_ARG_STRING, &mpd_password, 0, 
+  { "password",     'P', POPT_ARG_STRING, &mpd_password, 0, 
     "Connect with password.", "PASSWORD" },
   POPT_AUTOHELP
   { NULL, 0, 0, NULL, 0 }