Documentation tweaks

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@21523 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2005-07-23 18:39:38 +00:00
parent 4c2d6d004c
commit f5dc9d701d
3 changed files with 34 additions and 17 deletions

View file

@ -8,6 +8,9 @@
mingw ifdefs
* Tools/AGSHtml.h: Added defines for building without the gnustep
base library.
* Tools/gdnc.m: Fix minor documentation error.
* Tools/gdnc.1: Fix minor documentation error and add documentation
of flags to set public/network servers running.
2005-07-22 Richard Frith-Macdonald <rfm@gnu.org>

View file

@ -16,7 +16,9 @@ gdnc \- GNUstep Distributed Notification Center
.P
.SH DESCRIPTION
The gdnc daemon is used by GNUstep programs to send notifications and
messages to one another.
messages to one another. By default it uses private inter-process
communications accessible only to the curtrent user on the machine on
which it is running (where the operating system supports them).
.P
Every user needs to have his own instance of
.B gdnc
@ -26,7 +28,8 @@ will be started automatically as soon as it is needed,
it is recommended to start
.B gdnc
in a personal login script like ~/.bashrc or ~/.cshrc.
Alternatively you can launch gpbs when your windowing system or the
Alternatively (if you have no command-line tools which use distributed
notifications) you can launch gdnc when your windowing system or the
window manager is started. For example, on systems with X11 you can launch
.B gdnc
from your .xinitrc script or alternatively
@ -39,12 +42,21 @@ for a sample startup script.
To attach
.B gdnc
to a remote session use the
.IP "\fB-NXHost \fIhostname"
.IP "\fB-NSHost \fIhostname"
argument.
.P
To run a copy of the server to handle public notifications (available to all
users on the local machine)
.IP "\fB-GSPublic YES"
.P
To run a copy of the server to handle network-public notifications (available
to all users able to connect to the local machine on the network)
.IP "\fB-GSNetwork YES"
.P
.SH DIAGNOSTICS
.B gdomap -L GDNCServer
will lookup instances of gdnc.
will lookup instances of gdnc which were launched with the NSHost, GSPublic,
or GSNetwork command line arguments.
.P
Alternatively,
.B gdomap -N

View file

@ -1004,21 +1004,23 @@ ihandler(int sig)
@end
/** <p>The gdnc daemon is used by GNUstep programs to send notifications and
/**
<p>The gdnc daemon is used by GNUstep programs to send notifications and
messages to one another, in conjunction with the Base library
Notification-related classes.</p>
<p>Every user needs to have his own instance of gdnc running. While gdnc
will be started automatically as soon as it is needed, it is recommended
to start gdnc in a personal login script like ~/.bashrc or ~/.cshrc.
Alternatively you can launch gpbs when your windowing system or the
Alternatively (if you have no command-line tools which use distributed
notifications) you can launch gdnc when your windowing system or the
window manager is started. For example, on systems with X11 you can
launch gdnc from your .xinitrc script or alternatively - if you are
running Window Maker - put it in Window Maker's autostart script. See
the GNUstep Build Guide for a sample startup script.</p>
<p>Please see the man page for more information.
</p> */
<p>Please see the man page for more information.</p>
*/
int
main(int argc, char** argv, char** env)
{