[lastbash-cvs] lastbash lastbash.1,1.1,1.2

[Costin S. <cs...@us...>]

Update of /cvsroot/lastbash/lastbash
In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv26935

Modified Files:
	lastbash.1 
Log Message:
Added content to manpage.

Index: lastbash.1
===================================================================
RCS file: /cvsroot/lastbash/lastbash/lastbash.1,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- lastbash.1	13 Nov 2006 21:26:01 -0000	1.1
+++ lastbash.1	6 Dec 2006 15:30:52 -0000	1.2
@@ -5,21 +5,174 @@
 .\"
 .\" $Id$
 .\"
-.TH "lastbash" "1" "03 Nov 2006" "LastBASH" "Multimedia"
+.TH "lastbash" "1" "06 Dec 2006" "LastBASH" "Multimedia"
 .SH "NAME"
 lastbash \- Console player for Last.fm
 .SH "SYNOPSIS"
-lastbash [\-vVh] [station]
+\fBlastbash\fR [-aAdvh] [-p \fIplayer\fR] [-r \fIrefresh_interval\fR] [-u \fIusername\fR] [-c \fIcommand\fR] [\fIstation\fR]
 .SH "DESCRIPTION"
-To be done
+LastBASH is a console/terminal based Last.fm player.
+Although the default Last.fm player is a great one, it also is a graphical one and it could be somewhat inadequate for the die-hard terminal users, like some people I know.
+LastBASH tries to find its place among the other Last.fm players, filling this gap: the missing console player.
+.PP
+Basically, it is no more than a TUI frontend, written in Bash.
+It displays the information of the current playing track, keeps a history of the played tracks and allows the user to perform some actions on the current track, such as love, skip or ban.
 .SH "OPTIONS"
-To be done
-.SH "EXAMPLES"
-To be done
+.TP
+.B -a
+Do not start playing automatically.
+.TP
+.B -A
+Start playing automatically.
+.TP
+.B -d
+Enable debug mode (will create a log file at \fI~/.lastbash/lastbash.debug\fR).
+.TP
+.B -v
+Show program name and version.
+.TP
+.B -h
+Show a quick help.
+.TP
+.B -p \fIplayer\fR
+Set the backend player to use.
+.TP
+.B -r \fIrefresh_interval\fR
+Set the refresh interval, in seconds.
+.TP
+.B -u \fIusername\fR
+Set Last.fm username and re-request the password.
+.TP
+.B -c \fIcommand\fR
+Send \fIcommand\fR to the first instance.
+See \fBRemote control\fR below.
+.TP
+.I station
+Specify the Last.fm station to connect to when starting or to send to the first instance.
+See \fBRemote control\fR below.
+.SH "BASIC USAGE"
+After you have donwloaded, extracted and installed the program, run it.
+You do not need to pass any command line parameters, at least at first start.
+.PP
+.nf
+$ lastbash
+.fi
+.PP
+It will ask your Last.fm username and password.
+You should have one.
+If not, hmmm... go and create an account on Last.fm
+.PP
+You can also pass the Last.fm station name to tune directly into it.
+.PP
+.nf
+$ lastbash "lastfm://globaltags/rock"
+$ lastbash "lastfm://globaltags/classic rock"
+$ lastbash "lastfm://user/cstroie/neighbours"
+$ lastbash "lastfm://artist/Rammstein/similarartists"
+.fi
+.PP
+Then, the program will try to connect.
+If it succeeds, it will save a playlist in \fI~/.lastbash/playlist.m3u\fR, for you to open with some external player, if you don't want to use the backend it provides.
+
+If you have MPlayer (for the moment, this is the backend), it will start playing automatically. If not, you will have to tell LastBASH not to try to run it by creating the \fI~/.lastbash/config\fR file and adding this line:
+.PP
+.nf
+USE_PLAYER="n"
+.fi
+.PP
+Then, open your favourite mp3 player, load the above-mentioned playlist and start playing.
+LastBASH will show you the current playing track, will keep a history of last played tracks and will allow you to control the stream.
+.PP
+For example, to run MPlayer manually (just an example), run it this way:
+.PP
+.nf
+$ mplayer -cache 512 -playlist ~/.lastbash/playlist.m3u
+.fi
+.PP
+If you like xmms, run it this way (or just run it and open the playlist):
+.PP
+.nf
+$ xmms ~/.lastbash/playlist.m3u
+.fi
+.PP
+To use mpg123, the command is the following:
+.PP
+.nf
+$ mpg123 -C -v -@ ~/.lastbash/playlist.m3u
+.fi
+.SH "KEY BINDINGS"
+Basic key bindings are the following:
+.TP
+.B l
+Love track
+.TP
+.B k
+Skip track
+.TP
+.B b
+Ban track
+.TP
+.B r
+Refresh track metadata (refresh is automatic, but if you need to, you can use this key to force a refresh)
+.TP
+.B p
+Toggle "Record to Profile" (the P led will change status)
+.TP
+.B d
+Toggle "Discovery mode" (the D led will change status)
+.TP
+.B s
+Toggle history scrolling direction
+.TP
+.B ^L
+Redraw the interface
+.TP
+.B q
+Quit (and stop the backend player too)
+.SH "REMOTE CONTROL"
+If one instance of LastBASH is already running, a second call can send commands to the first one, for example:
+.PP
+.nf
+$ lastbash -c LOVE
+$ lastbash -c SKIP
+$ lastbash -c BAN
+.fi
+.PP
+Or you can change the station this way.
+.PP
+.nf
+$ lastbash "lastfm://group/LastBASH"
+.fi
+.SH "MOZILLA FIREFOX INTEGRATION"
+Open Firefox and type in the address bar the following.
+.PP
+.nf
+about:config
+.fi
+.PP
+Right click and select New > String . As name type the next string and press OK.
+.PP
+.nf
+network.protocol-handler.app.lastfm
+.fi
+.PP
+As value type the full path to the LastBASH programs, something like this one.
+.PP
+.nf
+/usr/bin/lastbash
+.fi
+.PP
+Now, go to Last.fm and click any \fIlastfm://\fR url.
+This will launch a second instance of the program and pass to the first one the new station.
+.SH "LAST.FM"
+This is shameless self-promotion, I know.
+You can find me on Last.fm as \fIcstroie\fR and, if you like this player and want to share your experience, you can join the \fILastBASH\fR group and tell others about it.
 .SH "LICENSE"
 GNU General Public License
 .SH "AUTHORS"
 Costin Stroie <cs...@us...>
 .SH "SEE ALSO"
-LastBASH website at: <http://lastbash.sourceforge.net/>
+LastBASH website at: <http://lastbash.sourceforge.net>
+.br
+LastBASH group at Last.fm: <http://www.last.fm/group/LastBASH>
 .\" vim: set ft=nroff nowrap nu: