From afc2fe2e800a23478aaeb0b62c03513233a92c66 Mon Sep 17 00:00:00 2001 Message-Id: From: Mark Wooding Date: Fri, 19 Oct 2007 20:58:21 +0100 Subject: [PATCH] document login window Organization: Straylight/Edgeware From: Richard Kettlewell --- doc/disobedience.1.in | 68 ++++++++++++++++++++++++++++++------------- 1 file changed, 47 insertions(+), 21 deletions(-) diff --git a/doc/disobedience.1.in b/doc/disobedience.1.in index 642a3a6..d68feec 100644 --- a/doc/disobedience.1.in +++ b/doc/disobedience.1.in @@ -27,7 +27,13 @@ disobedience \- GUI client for DisOrder jukebox is a graphical client for DisOrder. .SH "WINDOWS AND ICONS" .SS "File Menu" -This only has one option, "Quit", which terminates the program. +This has the following options: +.TP +.B Login +Brings up the \fBLogin Details Window\fR; see below. +.TP +.B Quit +Terminates the program. .SS "Edit Menu" This has the following options: .TP @@ -173,6 +179,35 @@ Play selected tracks. .TP .B "Select All Tracks" Select all tracks. +.SS "Login Details Window" +The login details window allows you to edit the connection details and +authorization information used by Disobedience. It has four text entry fields: +.TP +.B Hostname +The host to connect to. +.TP +.B Service +The service name or port number to connect to. +.TP +.B "User name" +The user name to log in as. +.TP +.B Password +The password to use when logging in. Note that this is NOT your login password +but is your password to the DisOrder server. +.PP +It has three buttons: +.TP +.B Login +This button attempts to (re-)connect to the server with the currently displayed +settings. The settings are not saved. +.TP +.B Save +This button saves the current settings in +.IR $HOME/.disorder/passwd . +.TP +.B Cancel +This button closes the window. .SS "Properties Window" This window contains details of one or more tracks and allows them to be edited. @@ -200,6 +235,9 @@ all changes. .B CTRL+A Select all tracks (queue/recent) .TP +.B CTRL+L +Brings up the \fBLogin Details Window\fR. +.TP .B CTRL+Q Quit. .SH OPTIONS @@ -258,27 +296,15 @@ If you are using on the same host as the server then no additional configuration should be required. .PP -If it is running on a different host then the server will need a -.B listen -directive in its configuration and the clien a matching -.B connect -directive. Also the client will need user passwords, either in -.IR pkgconfdir/config. USER -or -.IR ~ USER /.disorder.passwd . -.PP -You might use commands such as the following to set up a standalone instance of -Disobedience: +If it is running on a different host then the easiest way to set it up is to +use the login details window in Disobedience. Enter the connection details, +use Login to connect to the server, and then use Save to store them for future +sessions. .PP -.RS -.nf -cd -mkdir .disorder -echo password > .disorder/passwd -echo connect >> .disorder/passwd -chmod 600 .disorder/passwd -.fi -.RE +The other clients read their configuration from the same location so after +setting up with Disobedience, tools such as +.BR disorder (1) +should work as well. .SH "SEE ALSO" .BR disorder_config (5) .PP -- [mdw]