gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-22 16:33:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated docs

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@17472 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Adam Fedor 2003-08-13 03:45:58 +00:00
parent 859a97b7ca
commit ee627b6c6c
3 changed files with 239 additions and 192 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
ChangeLog
View file

@ -1,3 +1,9 @@
2003-08-05 Martin Brecher <martin@mb-itconsulting.com>
* Tools/gdnc.1: Updated man pages, fixed typos, unified format
and layout. Man pages are now installed unprocessed as it should be.
* Tools/gdomap.8: ditto.
2003-08-12 Yen-Ju Chen <yjchenx@hotmail.com>
* Source/Additions/Unicode.m (GetAvailableEncodings): Include

125
Tools/gdnc.1
View file

@ -1,58 +1,67 @@
GDNC(1) System Manuals GDNC(1)
NNAAMMEE
gdomap - GNU Distributed Notification Center
SSYYNNOOPPSSIISS
ggddnncc
DDEESSCCRRIIPPTTIIOONN
The gdnc daemon is used by GNUstep programs to send noti-
fications and messages to one another.
Every user needs to have his own instance of gdnc running.
While gdnc will be started automatically by applications,
it is recommend to start gdnc in a personal login script
like .bashrc or .cshrc. This avoids error messages as
well as additional waiting times on application launches.
Alternatively you could launch gdnc when X11 is started or
- if you are running Window Maker - put it Window Maker's
autostart script. See the _G_N_U_s_t_e_p _B_u_i_l_d _G_u_i_d_e for a sample
startup script.
OOPPTTIIOONNSS
To attach gpbs to a remote session use the _-_N_S_H_o_s_t _<_h_o_s_t_-
_n_a_m_e_> argument.
DDIIAAGGNNOOSSTTIICCSS
ggddoommaapp --LL GGDDNNCCSSeerrvveerr will lookup instances of gdnc.
Alternatively, ggddoommaapp --NN will list all registered names on
the local host.
SSEEEE AALLSSOO
gdomap(8), GNUstep(7), gpbs(1)
_T_h_e _G_N_U_s_t_e_p _B_u_i_l_d _G_u_i_d_e example startup script:
<http://documents.made-it.com/GNUstep/Build/
#GNUSTEP.SERVICES>
AAUUTTHHOORRSS
gdnc was written by Richard Frith-McDonald <rfm@gnu.org>
This man page was written by Martin Brecher <martin@mb-
itconsulting.com>
GNUstep June 2003 GDNC(1)
.\"gdnc(1) man page
.\"put together by Martin Brecher <martin@gnustep.de>
.\"
.\"Process this file with
.\"groff -man -Tascii gdnc.1
.\"
.TH GDNC 1 "August 2003" GNUstep "GNUstep System Manual"
.SH NAME
gdnc \- GNUstep Distributed Notification Center
.SH SYNOPSIS
.B gdnc
.P
.SH DESCRIPTION
The gdnc daemon is used by GNUstep programs to send notifications and
messages to one another.
.P
Every user needs to have his own instance of
.B gdnc
running. While
.B gdnc
will be started automatically as soon as it is needed,
it is recommend to start
.B gdnc
in a personal login script like ~/.bashrc or ~/.cshrc.
Alternatively you can launch gpbs 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
- if you are running Window Maker - put it in Window Maker's autostart script.
See the
.I GNUstep Build Guide
for a sample startup script.
.P
.SH OPTIONS
To attach
.B gdnc
to a remote session use the
.IP "\fB-NXHost \fIhostname"
argument.
.P
.SH DIAGNOSTICS
.B gdomap -L GDNCServer
will lookup instances of gdnc.
.P
Alternatively,
.B gdomap -N
will list all registered names on the local host.
.P
.SH SEE ALSO
gdomap(8), GNUstep(7), gpbs(1)
.PP
.I The GNUstep Build Guide
example startup script:
<http://gnustep.made-it.com/BuildGuide/index.html#GNUSTEP.SERVICES>
.P
.SH HISTORY
Work on
.B gdnc
started October 1998.
.PP
This manual page first appeared in gnustep-base 1.7.2 (July 2003).
.P
.SH AUTHORS
.B gdnc
was written by Richard Frith-McDonald <rfm@gnu.org>.
.PP
This man page was written by Martin Brecher <martin@mb-itconsulting.com>.

300
Tools/gdomap.8
View file

@ -1,141 +1,173 @@
GDOMAP(8) System Manuals GDOMAP(8)
.\"gdomap(8) man page
.\"put together by Martin Brecher <martin@gnustep.de>
.\"
.\"Process this file with
.\"groff -man -Tascii gdomap.8
.\"
.TH GDOMAP 8 "August 2003" GNUstep "GNUstep System Manual"
.SH NAME
gdomap \- GNUstep Distributed Objects name server
.SH SYNOPSIS
.B gdomap
.RB [ "-C\fP" | "-H\fP" ]
.RB [ -I
.IR pidfile ]
.RB [ -L
.IR name ]
.RB [ -M
.IR name ]
.RB [ -N ]
.RB [ -P
.IR number ]
.RB [ -R
.IR name ]
.RB [ -T
.IR type ]
.RB [ -U
.IR name ]
.RB [ -a
.IR file ]
.RB [ -c
.IR file ]
.RB [ -d ]
.RB [ -f ]
.RB [-i
.IR seconds ]
.RB [ -p ]
.SH DESCRIPTION
.B gdomap
The gdomap daemon is used by GNUstep programs to lookup distributed objects of
processes running on the local machine as well as across the network.
.P
Usually the gdomap daemon is started at system boot time and binds itself to
port 538. See the
.I GNUstep Build Guide
for a sample startup script.
NNAAMMEE
gdomap - GNU Distributed Objects name server
.P
Gdomap normally probes every machine on the local network to see if there
is a copy of gdomap running on it. This is done for class-C networks and
subnets of class-C networks. If your host is on a class-B or class-A net
then the default behaviour is to treat it as a class-C net and probe only
the hosts that would be expected on a class-C network of the same number.
.P
If you are running on a class-A or class-B network, or if your net has a
large number of hosts which will not have gdomap on them - you may want to
supply a configuration file listing the hosts to be probed explicitly,
rather than getting gdomap to probe all hosts on the local net.
.P
You may also want to supply the
.I configuration file
so that hosts which are
not actually on your local network can still be found when your code tries
to connect to a host using @"*" as the host name. NB. this functionality
does not exist in OpenStep.
.P
A
.I configuration file
consists of a list of IP addresses to be probed.
The IP addresses should be in standard 'dot' notation, one per line.
Empty lines are permitted in the configuration file.
Anything on a line after a hash ('#') is ignored.
You tell gdomap about the config file with the '-c' command line option.
.PP
gdomap uses the SIOCGIFCONF ioctl to build a list of IP addresses and
netmasks for the network interface cards on your machine. On some operating
systems, this facility is not available (or is broken), so you must tell
gdomap the addresses and masks of the interfaces using the '-a' command line
option. The file named with '-a' should contain a series of lines with
space separated pairs of addresses and masks in 'dot' notation.
You must NOT include loopback interfaces in this list.
If you want to support broadcasting of probe information on a network,
you may supply the broadcast address as a third item on the line.
If your operating system has some other method of giving you a list of
network interfaces and masks, please send me example code so that I can
implement it in gdomap.
SSYYNNOOPPSSIISS
ggddoommaapp [[--CC || --HH]] [[--II <<ppiiddffiillee>> ]] [[--LL <<nnaammee>> ]] [[--MM <<nnaammee>>]]
[[--NN]] [[--PP <<nnuummbbeerr>>]] [[--RR <<nnaammee>>]] [[--TT <<ttyyppee>>]] [[--UU <<nnaammee>>]] [[--aa
<<ffiillee>>]] [[--cc <<ffiillee>>]] [[--dd]] [[--ff]] [[--ii <<sseeccoonnddss>>]] [[--pp]]
.SH OPTIONS
.IP "\fB-C"
help about configuration
.IP "\fB-H"
general help
.IP "\fB-I"
pid file to write pid
.IP "\fB-L \fIname"
perform lookup for name then quit.
.IP "\fB-M \fIname"
machine name for
.B -L
and
.B -N
.IP "\fB-N"
list all names registered on host
.IP "\fB-P \fInumber"
port number required for
.B -R
option.
.IP "\fB-R \fIname"
register name locally then quit.
.IP "\fB-T \fItype"
port type for
.B -L
,
.B -R
and
.B -U
options -
tcp_gdo, udp_gdo,
tcp_foreign, udp_foreign.
.IP "\fB-U \fIname"
unregister name locally then quit.
.IP "\fB-a \fIfile"
use config file for interface list.
.IP "\fB-c \fIfile"
use config file for probe.
.IP "\fB-d"
extra debug logging (normally via syslog).
.IP "\fB-f"
avoid fork() to make debugging easy
.IP "\fB-i \fIseconds"
re-probe at this interval (roughly), min 60
.IP "\fB-p"
disable probing for other servers
.PP
.SH FILES
Use the
.B -c
option to specify a configuration file for gdomap. See under
.B DESCRIPTION
for possible configurations.
.SH DIAGNOSTICS
Kill with SIGUSR1 to obtain a dump of all known peers
in /tmp/gdomap.dump
.P
.B gdomap -N
lists all registered names on the local host.
DDEESSCCRRIIPPTTIIOONN
ggddoommaapp The gdomap daemon is used by GNUstep programs to
lookup distributed objects of processes running on the
local machine as well as across the network.
Usually the gdomap daemon is started at system boot time
and binds itself to port 538. See the _G_N_U_s_t_e_p _B_u_i_l_d _G_u_i_d_e
for a sample startup script.
Gdomap normally probes every machine on the local network
to see if there is a copy of gdomap running on it. This
is done for class-C networks and subnets of class-C net-
works. If your host is on a class-B or class-A net then
the default behaviour is to treat it as a class-C net and
probe only the hosts that would be expected on a class-C
network of the same number.
If you are running on a class-A or class-B network, or if
your net has a large number of hosts which will not have
gdomap on them - you may want to supply a configuration
file listing the hosts to be probed explicitly, rather
than getting gdomap to probe all hosts on the local net.
You may also want to supply the _c_o_n_f_i_g_u_r_a_t_i_o_n _f_i_l_e so that
hosts which are not actually on your local network can
still be found when your code tries to connect to a host
using @"*" as the host name. NB. this functionality does
not exist in OpenStep.
A _c_o_n_f_i_g_u_r_a_t_i_o_n _f_i_l_e consists of a list of IP addresses to
be probed. The IP addresses should be in standard 'dot'
notation, one per line. Empty lines are permitted in the
configuration file. Anything on a line after a hash ('#')
is ignored. You tell gdomap about the config file with
the '-c' command line option.
gdomap uses the SIOCGIFCONF ioctl to build a list of IP
addresses and netmasks for the network interface cards on
your machine. On some operating systems, this facility is
not available (or is broken), so you must tell gdomap the
addresses and masks of the interfaces using the '-a' com-
mand line option. The file named with '-a' should contain
a series of lines with space separated pairs of addresses
and masks in 'dot' notation. You must NOT include loop-
back interfaces in this list. If you want to support
broadcasting of probe information on a network, you may
supply the broadcast address as a third item on the line.
If your operating system has some other method of giving
you a list of network interfaces and masks, please send me
example code so that I can implement it in gdomap.
OOPPTTIIOONNSS
-C help about configuration
-H general help
-I pid file to write pid
-L name
perform lookup for name then quit.
-M name
machine name for -L and -N
-N list all names registered on host
-P number
port number required for R option.
-R name
register name locally then quit.
-T type
port type for L, R and U options - tcp_gdo,
udp_gdo, tcp_foreign, udp_foreign.
-U name
unregister name locally then quit.
-a file
use config file for interface list.
-c file
use config file for probe.
-d extra debug logging (normally via syslog).
-f avoid fork() to make debugging easy
-i seconds
re-probe at this interval (roughly), min 60
-p disable probing for other servers
FFIILLEESS
Use the -c option to specify a configuration file for
gdomap. See under DDEESSCCRRIIPPTTIIOONN for possible configurations.
DDIIAAGGNNOOSSTTIICCSS
Kill with SIGUSR1 to obtain a dump of all known peers in
/tmp/gdomap.dump
ggddoommaapp --NN lists all registered names on the local host.
SSEEEE AALLSSOO
ggddoommaapp --CC gives above instructions on how to set up
gdomap.
gdnc(1), GNUstep(7), gpbs(1)
_T_h_e _G_N_U_s_t_e_p _B_u_i_l_d _G_u_i_d_e example rc script:
<http://documents.made-it.com/GNUstep/Build/
#GNUSTEP.SERVICES>
AAUUTTHHOORR
Richard Frith-McDonald <rfm@gnu.org>
GNUstep June 2003 GDOMAP(8)
.SH SEE ALSO
.B gdomap -C
gives above instructions on how to set up gdomap.
.P
gdnc(1), GNUstep(7), gpbs(1)
.P
.I The GNUstep Build Guide
example rc script:
<http://gnustep.made-it.com/BuildGuide/index.html#GNUSTEP.SERVICES>
.P
.SH HISTORY
Work on
.B gdomap
started in October 1996.
.PP
This manual page first appeared in gnustep-base 1.7.1 (June 2003).
.P
.SH AUTHORS
.B gdomap
was written by Richard Frith-McDonald <rfm@gnu.org>
.PP
This manual page was put together by Martin Brecher
<martin@mb-itconsulting.com>.