More compact mode support. The notebook will disappear and is

[disorder] / doc / disorder.3

diff --git a/doc/disorder.3 b/doc/disorder.3
index d4257708b0acb04b27d65fd319d4a58db6bb3f73..2b71bf90ad4ed15daa60e7e500be2e88559d3382 100644 (file)
--- a/doc/disorder.3
+++ b/doc/disorder.3
@@ -1,20 +1,18 @@
 .\"
 .\"

-.\" Copyright (C) 2004, 2005, 2006 Richard Kettlewell
+.\" Copyright (C) 2004-2008 Richard Kettlewell

 .\"
 .\"

-.\" This program is free software; you can redistribute it and/or modify
+.\" This program is free software: you can redistribute it and/or modify

 .\" it under the terms of the GNU General Public License as published by
 .\" it under the terms of the GNU General Public License as published by

-.\" the Free Software Foundation; either version 2 of the License, or
+.\" the Free Software Foundation, either version 3 of the License, or

 .\" (at your option) any later version.
 .\" (at your option) any later version.

-.\"
-.\" This program is distributed in the hope that it will be useful, but
-.\" WITHOUT ANY WARRANTY; without even the implied warranty of
-.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-.\" General Public License for more details.
-.\"
+.\" 
+.\" This program is distributed in the hope that it will be useful,
+.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
+.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+.\" GNU General Public License for more details.
+.\" 

 .\" You should have received a copy of the GNU General Public License
 .\" You should have received a copy of the GNU General Public License

-.\" along with this program; if not, write to the Free Software
-.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
-.\" USA
+.\" along with this program.  If not, see <http://www.gnu.org/licenses/>.

 .\"
 .TH disorder 3
 .SH NAME
 .\"
 .TH disorder 3
 .SH NAME


@@ -148,7 +146,7 @@ If the track or key are not found a null pointer is returned.
 .IP
 This function sets the value of \fBkey\fR for \fBtrack\fR to
 \fBvalue\fR.
 .IP
 This function sets the value of \fBkey\fR for \fBtrack\fR to
 \fBvalue\fR.

-On success, 0 is returned; on error, -1 is returned.
+On success, 0 is returned; on error, \-1 is returned.

 .IP
 If \fBvalue\fR is a null pointer then the preference is deleted.
 .IP
 .IP
 If \fBvalue\fR is a null pointer then the preference is deleted.
 .IP


@@ -157,15 +155,6 @@ and are lost if the track is deleted; they should only ever have
 values that can be regenerated on demand.
 Other values are stored in the prefs database and never get
 automatically deleted.
 values that can be regenerated on demand.
 Other values are stored in the prefs database and never get
 automatically deleted.

-.PP
-.nf
-\fBconst char *disorder_track_random(void)
-.fi
-.IP
-Returns a pointer to a copy of the name of a randomly chosen track.
-Each non-alias track has an equal probability of being chosen.
-Aliases are never returned.
-Only available in server plugins.

 .SH "PLUGIN FUNCTIONS"
 This section describes the functions that you must implement to write various
 plugins.
 .SH "PLUGIN FUNCTIONS"
 This section describes the functions that you must implement to write various
 plugins.


@@ -303,7 +292,7 @@ match them back up to the right collection to call
 .fi
 .IP
 Check whether file \fBpath\fR under \fBroot\fR still exists.
 .fi
 .IP
 Check whether file \fBpath\fR under \fBroot\fR still exists.

-Should return 1 if it exists, 0 if it does not and -1 on error.
+Should return 1 if it exists, 0 if it does not and \-1 on error.

 This is run in the main server process.
 .PP
 Both scan and recheck are executed inside a subprocess, so it will not
 This is run in the main server process.
 .PP
 Both scan and recheck are executed inside a subprocess, so it will not


@@ -403,10 +392,10 @@ This function must never block, as it runs inside the main loop of the
 server.
 .IP
 On success, should return 0 and set \fB*playedp\fR to the number of
 server.
 .IP
 On success, should return 0 and set \fB*playedp\fR to the number of

-seconds played so far of this track, or to -1 if this cannot be
+seconds played so far of this track, or to \-1 if this cannot be

 determined.
 .IP
 determined.
 .IP

-On error, should return -1.
+On error, should return \-1.

 .PP
 .nf
 \fBvoid disorder_play_resume(void *data);
 .PP
 .nf
 \fBvoid disorder_play_resume(void *data);