Add documentation on options

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/back/trunk@23438 72102866-910b-0410-8b05-ffd578937521

ChangeLog

@@ -1,3 +1,7 @@
+2006-09-08 Adam Fedor <fedor@gnu.org>
+
+	Tools/gpbs.1: Add documentation on options (from Dennis Leeuw).
+
 2006-09-06 Richard Frith-Macdonald <rfm@gnu.org>
 
 	* Headers/x11/XGGeneric.h: New ivars to hold offsets for different

Tools/gpbs.1

@@ -5,48 +5,66 @@
 .\"Process this file with
 .\"groff -man -Tascii gpbs.1
 .\"
-.TH GPBS 1 "June 2003" GNUstep "GNUstep System Manual"
+.TH GPBS 1 "September 2006" GNUstep "GNUstep System Manual"
 .SH NAME
-gpbs \- GNUstep PasteBoard Server 
+gpbs \- GNUstep PasteBoard Server
 .SH SYNOPSIS
 .B gpbs
 .P
 .SH DESCRIPTION
-The 
+The
 .B gpbs
-daemon serves as a clipboard/pasteboard for GNUstep programs, 
+daemon serves as a clipboard/pasteboard for GNUstep programs,
-handling the copying, cutting and pasting of objects as well as 
+handling the copying, cutting and pasting of objects as well as
 drag and drop operations between applications.
 .P
-Every user needs to have his own instance of 
+Every user needs to have his own instance of
 .B gpbs
- running. While
+  running. While
 .B gpbs
-will be started automatically as soon as it is needed, 
+will be started automatically as soon as it is needed,
 it is recommend to start
-.B gpbs 
+.B gpbs
-in a personal login script like ~/.bashrc or ~/.cshrc. 
+in a personal login script like ~/.bashrc or ~/.cshrc.
-Alternatively you can launch gpbs when your windowing system or the 
+Alternatively you can launch gpbs when your windowing system or the
-window manager is started. For example, on systems with X11 you can launch
+window manager is started. For example, on systems with X11 you can 
+launch
 .B gpbs
 from your .xinitrc script or alternatively
-- if you are running Window Maker - put it in Window Maker's autostart script. 
+- if you are running Window Maker - put it in Window Maker's autostart 
-See the 
+script.
-.I GNUstep Build Guide 
+See the
+.I GNUstep Build Guide
 for a sample startup script.
 .P
 .SH OPTIONS
-To attach 
+.TP
-.B gpbs
+\fB\-NSHost\fR \fB<hostname>\fR
-to a remote session use the 
+attaches \fBgpbs\fR to a remote session.
-.I -NSHost <hostname> 
+
-argument.
+.TP
+\fB\--GSStartupNotification\fR
+sends a notification through the NSDistributedNotificationCenter (i.e. 
+gdnc) so that apps know that it has started up. This is only relevant 
+if the application itself tries to startup \fBgpbs\fR (which means 
+\fBgpbs\fR was not started at session login).
+.TP
+\fB\--daemon\fR
+starts \fBgpbs\fR as a daemon - mostly this means that all output gets 
+sent to syslog rather than the terminal.
+.TP
+\fB\--no-fork\fR
+does not fork a separate process
+.TP
+\fB\--verbose\fR
+makes \fB\gpbs\fR his logging more verbose
+
 .SH DIAGNOSTICS
 .B gdomap -L GNUstepGSPasteboardServer
-will lookup instances of 
+will lookup instances of
 .B gpbs.
 .P
-Alternatively, 
+Alternatively,
 .B gdomap -N
 will list all registered names on the local host.
 .P
@@ -55,17 +73,17 @@ Versions of
 .B gpbs
 up to (including) 1.7.2 have problems with copy and paste of
 mulit-lingual text, as it used the atom XA_STRING alone to
-exchange string data between X clients (and thus GNUstep clients).  
+exchange string data between X clients (and thus GNUstep clients).
 This means
 .B  gpbs
-is inherently unable to do cut-and-paste with characters 
+is inherently unable to do cut-and-paste with characters
 other than ISO Latin1 ones, TAB, and NEWLINE.
 .P
 .SH SEE ALSO
 gdnc(1), gdomap(8), GNUstep(7) xinit(1) wmaker(1)
 .P
 .I The GNUstep Build Guide
-example startup script: 
+example startup script:
 <http://gnustep.made-it.com/BuildGuide/index.html#GNUSTEP.SERVICES>
 .P
 .SH HISTORY
@@ -80,3 +98,6 @@ gpbs was written by Richard Frith-McDonald <rfm@gnu.org>
 .P
 This man page was written by Martin Brecher <martin@mb-itconsulting.com>
 with contributions from Kazunobu Kuriyama <kazunobu.kuriyama@nifty.com>.
+.P
+This man page was updated September 2006 by Dennis Leeuw 
+(dleeuw@made-it.com) with notes by Adam Fedor (fedor@doc.com).