Mercurial > hg > xemacs-beta

comparison etc/gnuserv.1 @ 181:bfd6434d15b3 r20-3b17

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Import from CVS: tag r20-3b17
author cvs
date Mon, 13 Aug 2007 09:53:19 +0200
parents 0132846995bd
children 90d73dddcdc4
comparison
equal deleted inserted replaced
180:add28d59e586 181:bfd6434d15b3
2 .UC 4 2 .UC 4
3 .SH NAME 3 .SH NAME
4 gnuserv, gnuclient \- Server and Clients for XEmacs 4 gnuserv, gnuclient \- Server and Clients for XEmacs
5 .SH SYNOPSIS 5 .SH SYNOPSIS
6 .B gnuclient 6 .B gnuclient
7 [-q] [-nw] [-l library] [-f function] [-eval form] [[-h hostname] 7 [-nw] [-display display] [-q] [-v] [-l library] [-batch] [-f function] [-eval form]
8 [-p port] [-r pathname]] [[+line] path] ... 8 [-h hostname] [-p port] [-r remote-pathname] [[+line] file] ...
9 .br
10 .B gnudoit [-q]
11 form
9 .br 12 .br
10 .B gnuserv 13 .B gnuserv
14 .br
15 .B gnuattach
16 Removed as of gnuserv 3.x
11 .SH DESCRIPTION 17 .SH DESCRIPTION
12 18
13 .PP 19 .PP
14 \fIgnuclient\fP allows the user to request a running XEmacs process to 20 \fIgnuclient\fP allows the user to request a running XEmacs process to
15 edit the named files or directories in a new frame. Depending on your 21 edit the named files or directories and/or evaluate lisp forms.
16 environment, it can be an X frame or a TTY frame. One typical use for 22 Depending on your environment, it can be an X frame or a TTY frame.
17 this is with a dialup connection to a machine on which an XEmacs 23 One typical use for this is with a dialup connection to a machine on
18 process is currently running. 24 which an XEmacs process is currently running.
25 .PP
26 \fIgnudoit\fP is a shell script frontend to ``gnuclient -batch -eval form''.
27 Its use is depreciated. Try to get used to calling gnuclient directly.
19 .PP 28 .PP
20 \fIgnuserv\fP is the server program that is set running by XEmacs to 29 \fIgnuserv\fP is the server program that is set running by XEmacs to
21 handle all incoming and outgoing requests. It is not usually invoked 30 handle all incoming and outgoing requests. It is not usually invoked
22 directly, but is started from XEmacs by loading the \fIgnuserv\fP 31 directly, but is started from XEmacs by loading the \fIgnuserv\fP
23 package and evaluating the Lisp form (gnuserv-start). 32 package and evaluating the Lisp form (gnuserv-start).
33 .PP
34 \fIgnuattach\fP no longer exists. Its functionality has been replaced by
35 \fIgnuclient -nw\fP.
24 .SH OPTIONS 36 .SH OPTIONS
37 .PP
38 \fIgnuclient\fP supports as much of the command line options of Emacs as
39 makes sense in this context. In addition it adds a few of its own.
40 .br
41 Options with long names can also be specified using a double
42 hyphen instead of a single one.
43 .TP 8
44 .BI \-nw
45 This option makes \fIgnuclient\fP act as a frontend such that XEmacs
46 can attach to the current TTY. XEmacs will then open a new TTY frame.
47 The effect is similar to having started a new XEmacs on this TTY with
48 the ``-nw'' option. It currently only works if XEmacs is running on
49 the same machine as gnuclient. This is the default if the `DISPLAY'
50 environment variable is not set.
51 .TP 8
52 .BI \-display " display, " \--display " display"
53 If this option is given or the `DISPLAY' environment variable is set
54 then gnuclient will tell XEmacs to edit files in a frame on the
55 specified X device.
25 .TP 8 56 .TP 8
26 .BI \-q 57 .BI \-q
27 This option informs \fIgnuclient\fP to exit once connection has been 58 This option informs \fIgnuclient\fP to exit once connection has been
28 made with the XEmacs process. Normally \fIgnuclient\fP waits until 59 made with the XEmacs process. Normally \fIgnuclient\fP waits until
29 all of the files on the command line have been finished with (their 60 all of the files on the command line have been finished with (their
30 buffers killed) by the XEmacs process, and all the forms have been 61 buffers killed) by the XEmacs process, and all the forms have been
31 evaluated. 62 evaluated.
32 .TP 8 63 .TP 8
64 .BI \-v
65 When this option is specified \fIgnuclient\fP will request for the
66 specified files to be viewed instead of edited.
67 .TP 8
68 .BI \-l " library"
69 Tell Emacs to load the specified library.
70 .TP 8
71 .BI \-batch
72 Tell Emacs not to open any frames. Just load libraries and evaluate lisp code. You
73 must use the
74 .BR \-l ,
75 .BR \-f ,
76 and
77 .B \-eval
78 options to specify files to execute and functions to call.
79 .TP 8
80 .BI \-f " function,"
81 Make Emacs execute the lisp function.
82 .TP 8
83 .BI \-eval " form"
84 Make Emacs execute the lisp form.
85 .TP 8
33 .BI \-h " hostname" 86 .BI \-h " hostname"
34 Used only with Internet-domain sockets, this option specifies the host 87 Used only with Internet-domain sockets, this option specifies the host
35 machine which should be running \fIgnuserv\fP. If this option is not 88 machine which should be running \fIgnuserv\fP. If this option is not
36 specified then the value of the environment variable GNU_HOST is used 89 specified then the value of the environment variable GNU_HOST is used
37 if set. If no hostname is specified, and the GNU_HOST variable is not 90 if set. If no hostname is specified, and the GNU_HOST variable is not
38 set, an internet connection will not be attempted. N\.B.: 91 set, an internet connection will not be attempted. N\.B.:
39 \fIgnuserv\fP does NOT allow internet connections unless the 92 \fIgnuserv\fP does NOT allow internet connections unless XAUTH
40 GNU_SECURE variable has been specified and points at a file listing 93 authentication is used or the GNU_SECURE variable has been specified
41 all trusted hosts. (See SECURITY below.) 94 and points at a file listing all trusted hosts. (See SECURITY below.)
42 95
43 .br 96 .br
44 Note that an internet address may be specified instead of a hostname 97 Note that an internet address may be specified instead of a hostname
45 which can speed up connections to the server by quite a bit, 98 which can speed up connections to the server by quite a bit,
46 especially if the client machine is running YP. 99 especially if the client machine is running YP.
71 server machine via the path /net/otter, then this argument should be 124 server machine via the path /net/otter, then this argument should be
72 set to '/net/otter'. If this option is omitted, then the value is 125 set to '/net/otter'. If this option is omitted, then the value is
73 taken from the environment variable GNU_NODE, if set, or the empty 126 taken from the environment variable GNU_NODE, if set, or the empty
74 string otherwise. 127 string otherwise.
75 .TP 8 128 .TP 8
76 .BI "path" 129 .BI "[+n] file"
77 This is the path of the file to be edited. If the file is a directory, then 130 This is the path of the file to be edited. If the file is a directory, then
78 the directory browsers dired or monkey are usually invoked instead. 131 the directory browsers dired or monkey are usually invoked instead.
79 .TP 8 132 The cursor is put at line number 'n' if specified.
80 .BI "sexpr" 133
81 This is part of an XEmacs LISP expression to evaluate. All the sexprs
82 are concatenated together and wrapped in a progn form before sending
83 to XEmacs.
84
85 .PP
86 .SH SETUP 134 .SH SETUP
87 \fIgnuserv\fP is packaged standardly with recent versions of XEmacs. 135 \fIgnuserv\fP is packaged standardly with recent versions of XEmacs.
88 Therefore, you should be able to start the server simply by evaluating 136 Therefore, you should be able to start the server simply by evaluating
89 the XEmacs Lisp form (gnuserv-start), or equivalently by typing 137 the XEmacs Lisp form (gnuserv-start), or equivalently by typing
90 `M-x gnuserv-start'. 138 `M-x gnuserv-start'.
139
140 .SH CONFIGURATION
141 The behavior of this suite of program is mostly controlled on the lisp
142 side in Emacs and its behavior can be customized to a large extent.
143 Type `M-x customize-group RET gnuserv RET' for easy access. More
144 documentation can be found in the file `gnuserv.el'
145
91 .SH EXAMPLE 146 .SH EXAMPLE
92 .RS 4 147 .RS 4
93 gnuclient -q -f mh-smail 148 gnuclient -q -f mh-smail
94 .br 149 .br
95 gnuclient -h cuckoo -r /ange@otter: /tmp/* 150 gnuclient -h cuckoo -r /ange@otter: /tmp/*
96 .br 151 .br
97 gnuclient -nw ../src/listproc.c 152 gnuclient -nw ../src/listproc.c
98 .RE 153 .RE
154 .br
155
156 .br
157 More examples and sample wrapper scripts are provided in the
158 etc/gnuserv directory of the Emacs installation.
159
99 160
100 .SH SYSV IPC 161 .SH SYSV IPC
101 SysV IPC is used to communicate between \fIgnuclient\fP and 162 SysV IPC is used to communicate between \fIgnuclient\fP and
102 \fIgnuserv\fP if the symbol SYSV_IPC is defined at the top of 163 \fIgnuserv\fP if the symbol SYSV_IPC is defined at the top of
103 gnuserv.h. This is incompatible with both Unix-domain and 164 gnuserv.h. This is incompatible with both Unix-domain and
196 name of the authorization protocol (i.e.`MIT-MAGIC-COOKIE-1') 257 name of the authorization protocol (i.e.`MIT-MAGIC-COOKIE-1')
197 .I is 258 .I is
198 significant! 259 significant!
199 .RE 260 .RE
200 261
262
263 .SH ENVIRONMENT
264 .PP
265 .TP 8
266 .B DISPLAY
267 Default X device to put edit frame.
268
201 .SH FILES 269 .SH FILES
202 .PP 270 .PP
203 .TP 8 271 .TP 8
204 .B /tmp/gsrv??? 272 .B /tmp/gsrv???
205 (SYSV_IPC only) 273 (SYSV_IPC only)
210 .B ~/.emacs 278 .B ~/.emacs
211 XEmacs customization file, see xemacs(1). 279 XEmacs customization file, see xemacs(1).
212 .SH SEE ALSO 280 .SH SEE ALSO
213 .PP 281 .PP
214 .TP 8 282 .TP 8
215 xauth(1X11), Xsecurity(1X11) 283 xauth(1X11), Xsecurity(1X11), gnuserv.el
216 .SH BUGS 284 .SH BUGS
217 .PP 285 .PP
218 NULs occurring in result strings don't get passed back to gnudoit properly. 286 NULs occurring in result strings don't get passed back to gnudoit properly.
219 287
220 .SH AUTHOR. 288 .SH AUTHOR.