Mercurial > hg > xemacs-beta
annotate etc/gnuserv.1 @ 2367:ecf1ebac70d8
[xemacs-hg @ 2004-11-04 23:05:23 by ben]
commit mega-patch
configure.in: Turn off -Winline and -Wchar-subscripts.
Use the right set of cflags when compiling modules.
Rewrite ldap configuration to separate the inclusion of lber
(needed in recent Cygwin) from the basic checks for the
needed libraries.
add a function for MAKE_JUNK_C; initially code was added to
generate xemacs.def using this, but it will need to be rewritten.
add an rm -f for junk.c to avoid weird Cygwin bug with cp -f onto
an existing file.
Sort list of auto-detected functions and eliminate unused checks for
stpcpy, setlocale and getwd.
Add autodetection of Cygwin scanf problems
BETA: Rewrite section on configure to indicate what flags are important
and what not.
digest-doc.c, make-dump-id.c, profile.c, sorted-doc.c: Add proper decls for main().
make-msgfile.c: Document that this is old junk.
Move proposal to text.c.
make-msgfile.lex: Move proposal to text.c.
make-mswin-unicode.pl: Convert error-generating code so that the entire message will
be seen as a single unrecognized token.
mule/mule-ccl.el: Update docs.
lispref/mule.texi: Update CCL docs.
ldap/eldap.c: Mule-ize.
Use EXTERNAL_LIST_LOOP_2 instead of deleted EXTERNAL_LIST_LOOP.
* XEmacs 21.5.18 "chestnut" is released.
---------------------------------------------------------------
MULE-RELATED WORK:
---------------------------------------------------------------
---------------------------
byte-char conversion
---------------------------
buffer.c, buffer.h, insdel.c, text.c: Port FSF algorithm for byte-char conversion, replacing broken
previous version. Track the char position of the gap. Add
functions to do char-byte conversion downwards as well as upwards.
Move comments about algorithm workings to internals manual.
---------------------------
work on types
---------------------------
alloc.c, console-x-impl.h, dump-data.c, dump-data.h, dumper.c, dialog-msw.c, dired-msw.c, doc.c, editfns.c, esd.c, event-gtk.h, event-msw.c, events.c, file-coding.c, file-coding.h, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-shared.c, glyphs-x.c, glyphs.c, glyphs.h, gui.c, hpplay.c, imgproc.c, intl-win32.c, lrecord.h, lstream.c, keymap.c, lisp.h, libsst.c, linuxplay.c, miscplay.c, miscplay.h, mule-coding.c, nas.c, nt.c, ntheap.c, ntplay.c, objects-msw.c, objects-tty.c, objects-x.c, print.c, process-nt.c, process.c, redisplay.h, select-common.h, select-gtk.c, select-x.c, sgiplay.c, sound.c, sound.h, sunplay.c, sysfile.h, sysdep.c, syswindows.h, text.c, unexnt.c, win32.c, xgccache.c: Further work on types. This creates a full set of types for all
the basic semantics of `char' that I have so far identified, so that
its semantics can always be identified for the purposes of proper
Mule-safe code, and the raw use of `char' always avoided.
(1) More type renaming, for consistency of naming.
Char_ASCII -> Ascbyte
UChar_ASCII -> UAscbyte
Char_Binary -> CBinbyte
UChar_Binary -> Binbyte
SChar_Binary -> SBinbyte
(2) Introduce Rawbyte, CRawbyte, Boolbyte, Chbyte, UChbyte, and
Bitbyte and use them.
(3) New types Itext, Wexttext and Textcount for separating out
the concepts of bytes and textual units (different under UTF-16
and UTF-32, which are potential internal encodings).
(4) qxestr*_c -> qxestr*_ascii.
lisp.h: New; goes with other qxe() functions. #### Maybe goes in a
different section.
lisp.h: Group generic int-type defs together with EMACS_INT defs.
lisp.h: * lisp.h (WEXTTEXT_IS_WIDE)
New defns.
lisp.h: New type to replace places where int occurs as a boolean.
It's signed because occasionally people may want to use -1 as
an error value, and because unsigned ints are viral -- see comments
in the internals manual against using them.
dynarr.c: int -> Bytecount.
---------------------------
Mule-izing
---------------------------
device-x.c: Partially Mule-ize.
dumper.c, dumper.h: Mule-ize. Use Rawbyte. Use stderr_out not printf. Use wext_*().
sysdep.c, syswindows.h, text.c: New Wexttext API for manipulation of external text that may be
Unicode (e.g. startup code under Windows).
emacs.c: Mule-ize. Properly deal with argv in external encoding.
Use wext_*() and Wexttext. Use Rawbyte.
#if 0 some old junk on SCO that is unlikely to be correct.
Rewrite allocation code in run-temacs.
emacs.c, symsinit.h, win32.c: Rename win32 init function and call it even earlier, to
initialize mswindows_9x_p even earlier, for use in startup code
(XEUNICODE_P).
process.c: Use _wenviron not environ under Windows, to get Unicode environment
variables.
event-Xt.c: Mule-ize drag-n-drop related stuff.
dragdrop.c, dragdrop.h, frame-x.c: Mule-ize.
text.h: Add some more stand-in defines for particular kinds of conversion;
use in Mule-ization work in frame-x.c etc.
---------------------------
Freshening
---------------------------
intl-auto-encap-win32.c, intl-auto-encap-win32.h: Regenerate.
---------------------------
Unicode-work
---------------------------
intl-win32.c, syswindows.h: Factor out common options to MultiByteToWideChar and
WideCharToMultiByte. Add convert_unicode_to_multibyte_malloc()
and convert_unicode_to_multibyte_dynarr() and use. Add stuff for
alloca() conversion of multibyte/unicode.
alloc.c: Use dfc_external_data_len() in case of unicode coding system.
alloc.c, mule-charset.c: Don't zero out and reinit charset Unicode tables. This fucks up
dump-time loading. Anyway, either we load them at dump time or
run time, never both.
unicode.c: Dump the blank tables as well.
---------------------------------------------------------------
DOCUMENTATION, MOSTLY MULE-RELATED:
---------------------------------------------------------------
EmacsFrame.c, emodules.c, event-Xt.c, fileio.c, input-method-xlib.c, mule-wnnfns.c, redisplay-gtk.c, redisplay-tty.c, redisplay-x.c, regex.c, sysdep.c: Add comment about Mule work needed.
text.h: Add more documentation describing why DFC routines were not written
to return their value. Add some other DFC documentation.
console-msw.c, console-msw.h: Add pointer to docs in win32.c.
emacs.c: Add comments on sources of doc info.
text.c, charset.h, unicode.c, intl-win32.c, intl-encap-win32.c, text.h, file-coding.c, mule-coding.c: Collect background comments and related to text matters and
internationalization, and proposals for work to be done, in text.c
or Internals manual, stuff related to specific textual API's in
text.h, and stuff related to internal implementation of Unicode
conversion in unicode.c. Put lots of pointers to the comments to
make them easier to find.
s/mingw32.h, s/win32-common.h, s/win32-native.h, s/windowsnt.h, win32.c: Add bunches of new documentation on the different kinds of
builds and environments under Windows and how they work.
Collect this info in win32.c. Add pointers to these docs in
the relevant s/* files.
emacs.c: Document places with long comments.
Remove comment about exiting, move to internals manual, put
in pointer.
event-stream.c: Move docs about event queues and focus to internals manual, put
in pointer.
events.h: Move docs about event stream callbacks to internals manual, put
in pointer.
profile.c, redisplay.c, signal.c: Move documentation to the Internals manual.
process-nt.c: Add pointer to comment in win32-native.el.
lisp.h: Add comments about some comment conventions.
lisp.h: Add comment about the second argument.
device-msw.c, redisplay-msw.c: @@#### comments are out-of-date.
---------------------------------------------------------------
PDUMP WORK (MOTIVATED BY UNICODE CHANGES)
---------------------------------------------------------------
alloc.c, buffer.c, bytecode.c, console-impl.h, console.c, device.c, dumper.c, lrecord.h, elhash.c, emodules.h, events.c, extents.c, frame.c, glyphs.c, glyphs.h, mule-charset.c, mule-coding.c, objects.c, profile.c, rangetab.c, redisplay.c, specifier.c, specifier.h, window.c, lstream.c, file-coding.h, file-coding.c: PDUMP:
Properly implement dump_add_root_block(), which never worked before,
and is necessary for dumping Unicode tables.
Pdump name changes for accuracy:
XD_STRUCT_PTR -> XD_BLOCK_PTR.
XD_STRUCT_ARRAY -> XD_BLOCK_ARRAY.
XD_C_STRING -> XD_ASCII_STRING.
*_structure_* -> *_block_*.
lrecord.h: some comments added about
dump_add_root_block() vs dump_add_root_block_ptr().
extents.c: remove incorrect comment about pdump problems with gap array.
---------------------------------------------------------------
ALLOCATION
---------------------------------------------------------------
abbrev.c, alloc.c, bytecode.c, casefiddle.c, device-msw.c, device-x.c, dired-msw.c, doc.c, doprnt.c, dragdrop.c, editfns.c, emodules.c, file-coding.c, fileio.c, filelock.c, fns.c, glyphs-eimage.c, glyphs-gtk.c, glyphs-msw.c, glyphs-x.c, gui-msw.c, gui-x.c, imgproc.c, intl-win32.c, lread.c, menubar-gtk.c, menubar.c, nt.c, objects-msw.c, objects-x.c, print.c, process-nt.c, process-unix.c, process.c, realpath.c, redisplay.c, search.c, select-common.c, symbols.c, sysdep.c, syswindows.h, text.c, text.h, ui-byhand.c: New macros {alloca,xnew}_{itext,{i,ext,raw,bin,asc}bytes} for
more convenient allocation of these commonly requested items.
Modify functions to use alloca_ibytes, alloca_array, alloca_extbytes,
xnew_ibytes, etc. also XREALLOC_ARRAY, xnew.
alloc.c: Rewrite the allocation functions to factor out repeated code.
Add assertions for freeing dumped data.
lisp.h: Moved down and consolidated with other allocation stuff.
lisp.h, dynarr.c: New functions for allocation that's very efficient when mostly in
LIFO order.
lisp.h, text.c, text.h: Factor out some stuff for general use by alloca()-conversion funs.
text.h, lisp.h: Fill out convenience routines for allocating various kinds of
bytes and put them in lisp.h. Use them in place of xmalloc(),
ALLOCA().
text.h: Fill out the convenience functions so the _MALLOC() kinds match
the alloca() kinds.
---------------------------------------------------------------
ERROR-CHECKING
---------------------------------------------------------------
text.h: Create ASSERT_ASCTEXT_ASCII() and ASSERT_ASCTEXT_ASCII_LEN()
from similar Eistring checkers and change the Eistring checkers to
use them instead.
---------------------------------------------------------------
MACROS IN LISP.H
---------------------------------------------------------------
lisp.h: Redo GCPRO declarations. Create a "base" set of functions that can
be used to generate any kind of gcpro sets -- regular, ngcpro,
nngcpro, private ones used in GC_EXTERNAL_LIST_LOOP_2.
buffer.c, callint.c, chartab.c, console-msw.c, device-x.c, dialog-msw.c, dired.c, extents.c, ui-gtk.c, rangetab.c, nt.c, mule-coding.c, minibuf.c, menubar-msw.c, menubar.c, menubar-gtk.c, lread.c, lisp.h, gutter.c, glyphs.c, glyphs-widget.c, fns.c, fileio.c, file-coding.c, specifier.c: Eliminate EXTERNAL_LIST_LOOP, which does not check for circularities.
Use EXTERNAL_LIST_LOOP_2 instead or EXTERNAL_LIST_LOOP_3
or EXTERNAL_PROPERTY_LIST_LOOP_3 or GC_EXTERNAL_LIST_LOOP_2
(new macro). Removed/redid comments on EXTERNAL_LIST_LOOP.
---------------------------------------------------------------
SPACING FIXES
---------------------------------------------------------------
callint.c, hftctl.c, number-gmp.c, process-unix.c: Spacing fixes.
---------------------------------------------------------------
FIX FOR GEOMETRY PROBLEM IN FIRST FRAME
---------------------------------------------------------------
unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by
release 1.5.12 of Cygwin].
toolbar.c: bug fix for problem of initial frame being 77 chars wide on Windows.
will be overridden by my other ws.
---------------------------------------------------------------
FIX FOR LEAKING PROCESS HANDLES:
---------------------------------------------------------------
process-nt.c: Fixes for leaking handles. Inspired by work done by Adrian Aichner
<adrian@xemacs.org>.
---------------------------------------------------------------
FIX FOR CYGWIN BUG (Unicode-related):
---------------------------------------------------------------
unicode.c: Add workaround for newlib bug in sscanf() [should be fixed by
release 1.5.12 of Cygwin].
---------------------------------------------------------------
WARNING FIXES:
---------------------------------------------------------------
console-stream.c: `reinit' is unused.
compiler.h, event-msw.c, frame-msw.c, intl-encap-win32.c, text.h: Add stuff to deal with ANSI-aliasing warnings I got.
regex.c: Gather includes together to avoid warning.
---------------------------------------------------------------
CHANGES TO INITIALIZATION ROUTINES:
---------------------------------------------------------------
buffer.c, emacs.c, console.c, debug.c, device-x.c, device.c, dragdrop.c, emodules.c, eval.c, event-Xt.c, event-gtk.c, event-msw.c, event-stream.c, event-tty.c, events.c, extents.c, faces.c, file-coding.c, fileio.c, font-lock.c, frame-msw.c, glyphs-widget.c, glyphs.c, gui-x.c, insdel.c, lread.c, lstream.c, menubar-gtk.c, menubar-x.c, minibuf.c, mule-wnnfns.c, objects-msw.c, objects.c, print.c, scrollbar-x.c, search.c, select-x.c, text.c, undo.c, unicode.c, window.c, symsinit.h: Call reinit_*() functions directly from emacs.c, for clarity.
Factor out some redundant init code. Move disallowed stuff
that had crept into vars_of_glyphs() into complex_vars_of_glyphs().
Call init_eval_semi_early() from eval.c not in the middle of
vars_of_() in emacs.c since there should be no order dependency
in the latter calls.
---------------------------------------------------------------
ARMAGEDDON:
---------------------------------------------------------------
alloc.c, emacs.c, lisp.h, print.c: Rename inhibit_non_essential_printing_operations to
inhibit_non_essential_conversion_operations.
text.c: Assert on !inhibit_non_essential_conversion_operations.
console-msw.c, print.c: Don't do conversion in SetConsoleTitle or FindWindow to avoid
problems during armageddon. Put #errors for NON_ASCII_INTERNAL_FORMAT
in places where problems would arise.
---------------------------------------------------------------
CHANGES TO THE BUILD PROCEDURE:
---------------------------------------------------------------
config.h.in, s/cxux.h, s/usg5-4-2.h, m/powerpc.h: Add comment about correct ordering of this file.
Rearrange everything to follow this -- put all #undefs together
and before the s&m files. Add undefs for HAVE_ALLOCA, C_ALLOCA,
BROKEN_ALLOCA_IN_FUNCTION_CALLS, STACK_DIRECTION. Remove unused
HAVE_STPCPY, HAVE_GETWD, HAVE_SETLOCALE.
m/gec63.h: Deleted; totally broken, not used at all, not in FSF.
m/7300.h, m/acorn.h, m/alliant-2800.h, m/alliant.h, m/altos.h, m/amdahl.h, m/apollo.h, m/att3b.h, m/aviion.h, m/celerity.h, m/clipper.h, m/cnvrgnt.h, m/convex.h, m/cydra5.h, m/delta.h, m/delta88k.h, m/dpx2.h, m/elxsi.h, m/ews4800r.h, m/gould.h, m/hp300bsd.h, m/hp800.h, m/hp9000s300.h, m/i860.h, m/ibmps2-aix.h, m/ibmrs6000.h, m/ibmrt-aix.h, m/ibmrt.h, m/intel386.h, m/iris4d.h, m/iris5d.h, m/iris6d.h, m/irist.h, m/isi-ov.h, m/luna88k.h, m/m68k.h, m/masscomp.h, m/mg1.h, m/mips-nec.h, m/mips-siemens.h, m/mips.h, m/news.h, m/nh3000.h, m/nh4000.h, m/ns32000.h, m/orion105.h, m/pfa50.h, m/plexus.h, m/pmax.h, m/powerpc.h, m/pyrmips.h, m/sequent-ptx.h, m/sequent.h, m/sgi-challenge.h, m/symmetry.h, m/tad68k.h, m/tahoe.h, m/targon31.h, m/tekxd88.h, m/template.h, m/tower32.h, m/tower32v3.h, m/ustation.h, m/vax.h, m/wicat.h, m/xps100.h: Delete C_ALLOCA, HAVE_ALLOCA, STACK_DIRECTION,
BROKEN_ALLOCA_IN_FUNCTION_CALLS. All of this is auto-detected.
When in doubt, I followed recent FSF sources, which also have
these things deleted.
| author | ben |
|---|---|
| date | Thu, 04 Nov 2004 23:08:28 +0000 |
| parents | 5aa1854ad537 |
| children | 807b51903ed4 |
| rev | line source |
|---|---|
| 428 | 1 .TH GNUSERV 1 "" "XEmacs Server" |
| 2 .UC 4 | |
| 3 .SH NAME | |
| 4 gnuserv, gnuclient \- Server and Clients for XEmacs | |
| 5 .SH SYNOPSIS | |
| 6 .B gnuclient | |
| 7 [-nw] [-display display] [-q] [-v] [-l library] [-batch] [-f function] [-eval form] | |
| 8 [-h hostname] [-p port] [-r remote-pathname] [[+line] file] ... | |
| 9 .br | |
| 10 .B gnudoit [-q] | |
| 11 form | |
| 12 .br | |
| 13 .B gnuserv | |
| 14 .br | |
| 15 .B gnuattach | |
| 16 Removed as of gnuserv 3.x | |
| 17 .SH DESCRIPTION | |
| 18 | |
| 19 .PP | |
| 20 \fIgnuclient\fP allows the user to request a running XEmacs process to | |
| 21 edit the named files or directories and/or evaluate lisp forms. | |
| 22 Depending on your environment, it can be an X frame or a TTY frame. | |
| 23 One typical use for this is with a dialup connection to a machine on | |
| 24 which an XEmacs process is currently running. | |
| 25 .PP | |
| 26 \fIgnudoit\fP is a shell script frontend to ``gnuclient -batch -eval form''. | |
| 442 | 27 Its use is deprecated. Try to get used to calling gnuclient directly. |
| 428 | 28 .PP |
| 29 \fIgnuserv\fP is the server program that is set running by XEmacs to | |
| 30 handle all incoming and outgoing requests. It is not usually invoked | |
| 31 directly, but is started from XEmacs by loading the \fIgnuserv\fP | |
| 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. | |
| 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. | |
| 56 .TP 8 | |
| 57 .BI \-q | |
| 58 This option informs \fIgnuclient\fP to exit once connection has been | |
| 59 made with the XEmacs process. Normally \fIgnuclient\fP waits until | |
| 60 all of the files on the command line have been finished with (their | |
| 61 buffers killed) by the XEmacs process, and all the forms have been | |
| 62 evaluated. | |
| 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 | |
| 73 lisp code. If no files to execute, functions to call or forms to eval | |
| 74 are given using the | |
| 75 .BR \-l , | |
| 76 .BR \-f , | |
| 77 or | |
| 78 .B \-eval | |
| 79 options, then forms to eval are read from STDIN. | |
| 80 .TP 8 | |
| 81 .BI \-f " function," | |
| 82 Make Emacs execute the lisp function. | |
| 83 .TP 8 | |
| 84 .BI \-eval " form" | |
| 85 Make Emacs execute the lisp form. | |
| 86 .TP 8 | |
| 87 .BI \-h " hostname" | |
| 88 Used only with Internet-domain sockets, this option specifies the host | |
| 89 machine which should be running \fIgnuserv\fP. If this option is not | |
| 90 specified then the value of the environment variable GNU_HOST is used | |
| 91 if set. If no hostname is specified, and the GNU_HOST variable is not | |
| 92 set, an internet connection will not be attempted. N\.B.: | |
| 93 \fIgnuserv\fP does NOT allow internet connections unless XAUTH | |
| 94 authentication is used or the GNU_SECURE variable has been specified | |
| 95 and points at a file listing all trusted hosts. (See SECURITY below.) | |
| 96 | |
| 97 .br | |
| 98 Note that an internet address may be specified instead of a hostname | |
| 99 which can speed up connections to the server by quite a bit, | |
| 100 especially if the client machine is running YP. | |
| 101 | |
| 102 .br | |
| 103 Note also that a hostname of \fBunix\fP can be used to specify that | |
| 104 the connection to the server should use a Unix-domain socket (if | |
| 105 supported) rather than an Internet-domain socket. | |
| 106 .TP 8 | |
| 107 .BI \-p " port" | |
| 108 Used only with Internet-domain sockets, this option specifies the | |
| 109 service port used to communicate between server and clients. If this | |
| 110 option is not specified, then the value of the environment variable | |
| 111 GNU_PORT is used, if set, otherwise a service called ``gnuserv'' is | |
| 112 looked up in the services database. Finally, if no other value can be | |
| 113 found for the port, then a default port is used which is usually 21490 | |
| 114 + uid. | |
| 115 .br | |
| 116 Note that since \fIgnuserv\fP doesn't allow command-line options, the port for | |
| 117 it will have to be specified via one of the alternative methods. | |
| 118 .TP 8 | |
| 119 .BI \-r " pathname" | |
| 120 Used only with Internet-domain sockets, the pathname argument may be | |
| 121 needed to inform XEmacs how to reach the root directory of a remote | |
| 122 machine. \fIgnuclient\fP prepends this string to each path argument | |
| 123 given. For example, if you were trying to edit a file on a client | |
| 124 machine called otter, whose root directory was accessible from the | |
| 125 server machine via the path /net/otter, then this argument should be | |
| 126 set to '/net/otter'. If this option is omitted, then the value is | |
| 127 taken from the environment variable GNU_NODE, if set, or the empty | |
| 128 string otherwise. | |
| 129 .TP 8 | |
| 130 .BI "[+n] file" | |
| 131 This is the path of the file to be edited. If the file is a directory, then | |
| 132 the directory browsers dired or monkey are usually invoked instead. | |
| 133 The cursor is put at line number 'n' if specified. | |
| 134 | |
| 135 .SH SETUP | |
| 136 \fIgnuserv\fP is packaged standardly with recent versions of XEmacs. | |
| 137 Therefore, you should be able to start the server simply by evaluating | |
| 138 the XEmacs Lisp form (gnuserv-start), or equivalently by typing | |
| 139 `M-x gnuserv-start'. | |
| 140 | |
| 141 .SH CONFIGURATION | |
| 142 The behavior of this suite of program is mostly controlled on the lisp | |
| 143 side in Emacs and its behavior can be customized to a large extent. | |
| 144 Type `M-x customize-group RET gnuserv RET' for easy access. More | |
| 145 documentation can be found in the file `gnuserv.el' | |
| 146 | |
| 147 .SH EXAMPLE | |
| 148 .RS 4 | |
| 149 gnuclient -q -f mh-smail | |
| 150 .br | |
| 151 gnuclient -h cuckoo -r /ange@otter: /tmp/* | |
| 152 .br | |
| 153 gnuclient -nw ../src/listproc.c | |
| 154 .RE | |
| 155 .br | |
| 156 | |
| 157 .br | |
| 158 More examples and sample wrapper scripts are provided in the | |
| 159 etc/gnuserv directory of the Emacs installation. | |
| 160 | |
| 161 | |
| 162 .SH SYSV IPC | |
| 163 SysV IPC is used to communicate between \fIgnuclient\fP and | |
| 164 \fIgnuserv\fP if the symbol SYSV_IPC is defined at the top of | |
| 165 gnuserv.h. This is incompatible with both Unix-domain and | |
| 166 Internet-domain socket communication as described below. A file called | |
| 167 /tmp/gsrv??? is created as a key for the message queue, and if removed | |
| 168 will cause the communication between server and client to fail until | |
| 169 the server is restarted. | |
| 170 .SH UNIX-DOMAIN SOCKETS | |
| 171 A Unix-domain socket is used to communicate between \fIgnuclient\fP | |
| 172 and \fIgnuserv\fP if the symbol UNIX_DOMAIN_SOCKETS is defined at the | |
| 173 top of gnuserv.h. A file called /tmp/gsrvdir????/gsrv is created for | |
| 464 | 174 communication. If the symbol USE_TMPDIR is set at the top of gnuserv.h, |
| 175 $TMPDIR, when set, is used instead of /tmp. If that file is deleted, | |
| 176 or TMPDIR has different values for the server and the client, communication | |
| 177 between server and client will fail. Only the user running gnuserv will be | |
| 178 able to connect to the socket. | |
| 428 | 179 .SH INTERNET-DOMAIN SOCKETS |
| 180 Internet-domain sockets are used to communicate between | |
| 181 \fIgnuclient\fP and \fIgnuserv\fP if the symbol | |
| 182 INTERNET_DOMAIN_SOCKETS is defined at the top of gnuserv.h. Both | |
| 183 Internet-domain and Unix-domain sockets can be used at the same | |
| 184 time. If a hostname is specified via -h or via the GNU_HOST | |
| 185 environment variable, \fIgnuclient\fP establish connections using an | |
| 186 internet domain socket. If not, a local connection is attempted via | |
| 187 either a unix-domain socket or SYSV IPC. | |
| 188 .SH SECURITY | |
| 189 Using Internet-domain sockets, a more robust form of security is | |
| 190 needed that wasn't necessary with either Unix-domain sockets or SysV | |
| 191 IPC. Currently, two authentication protocols are supported to provide | |
| 192 this: MIT-MAGIC-COOKIE-1 (based on the X11 xauth(1) program) and a | |
| 193 simple host-based access control mechanism, hereafter called | |
| 194 GNUSERV-1. The GNUSERV-1 protocol is always available, whereas support | |
| 195 for MIT-MAGIC-COOKIE-1 may or may not have been enabled (via a #define | |
| 196 at the top of gnuserv.h) at compile-time. | |
| 197 .PP | |
| 198 \fIgnuserv\fP, using GNUSERV-1, performs a limited form of access | |
| 199 control at the machine level. By default no internet-domain socket is | |
| 200 opened. If the variable GNU_SECURE can be found in \fIgnuserv\fP's | |
| 201 environment, and it names a readable filename, then this file is | |
| 202 opened and assumed to be a list of hosts, one per line, from which the | |
| 203 server will allow requests. Connections from any other host will be | |
| 204 rejected. Even the machine on which \fIgnuserv\fP is running is not | |
| 205 permitted to make connections via the internet socket unless its | |
| 206 hostname is explicitly specified in this file. Note that a host may | |
| 207 be either a numeric IP address or a hostname, and that | |
| 208 .I any | |
| 209 user on an approved host may connect to your gnuserv and execute arbitrary | |
| 210 elisp (e.g., delete all your files). | |
| 211 If this file contains a lot of | |
| 212 hostnames then the server may take quite a time to start up. | |
| 213 .PP | |
| 214 When the MIT-MAGIC-COOKIE-1 protocol is enabled, an internet socket | |
| 215 \fIis\fP opened by default. \fIgnuserv\fP will accept a connection from | |
| 216 any host, and will wait for a "magic cookie" (essentially, a password) | |
| 217 to be presented by the client. If the client doesn't present the | |
| 218 cookie, or if the cookie is wrong, the authentication of the client is | |
| 219 considered to have failed. At this point. \fIgnuserv\fP falls back to | |
| 220 the GNUSERV-1 protocol; If the client is calling from a host listed in | |
| 221 the GNU_SECURE file, the connection will be accepted, otherwise it | |
| 222 will be rejected. | |
| 223 .TP 4 | |
| 224 .I Using MIT-MAGIC-COOKIE-1 authentication | |
| 225 When the \fIgnuserv\fP server is started, it looks for a cookie | |
| 226 defined for display 999 on the machine where it is running. If the | |
| 227 cookie is found, it will be stored for use as the authentication | |
| 228 cookie. These cookies are defined in an authorization file (usually | |
| 229 ~/.Xauthority) that is manipulated by the X11 xauth(1) program. For | |
| 230 example, a machine "kali" which runs an emacs that invokes | |
| 231 \fIgnuserv\fP should respond as follows (at the shell prompt) when set | |
| 232 up correctly. | |
| 233 .PP | |
| 234 .RS 8 | |
| 235 kali% xauth list | |
| 236 .br | |
| 237 GS65.SP.CS.CMU.EDU:0 MIT-MAGIC-COOKIE-1 11223344 | |
| 238 .br | |
| 239 KALI.FTM.CS.CMU.EDU:999 MIT-MAGIC-COOKIE-1 1234 | |
| 240 .RE | |
| 241 .PP | |
| 242 .RS 4 | |
| 243 In the above case, the authorization file defines two cookies. The | |
| 244 second one, defined for screen 999 on the server machine, is used for | |
| 245 gnuserv authentication. | |
| 246 .PP | |
| 247 On the client machine's side, the authorization file must contain an | |
| 248 identical line, specifying the | |
| 249 .I server's | |
| 250 cookie. In other words, on a machine "foobar" which wishes to connect | |
| 251 to "kali," the `xauth list' output should contain the line: | |
| 252 .PP | |
| 253 .RS 4 | |
| 254 KALI.FTM.CS.CMU.EDU:999 MIT-MAGIC-COOKIE-1 1234 | |
| 255 .RE | |
| 256 .PP | |
| 257 For more information on authorization files, take a look at the | |
| 258 xauth(1X11) man page, or invoke xauth interactively (without any | |
| 259 arguments) and type "help" at the prompt. Remember that case in the | |
| 260 name of the authorization protocol (i.e.`MIT-MAGIC-COOKIE-1') | |
| 261 .I is | |
| 262 significant! | |
| 263 .RE | |
| 264 | |
| 265 | |
| 266 .SH ENVIRONMENT | |
| 267 .PP | |
| 268 .TP 8 | |
| 269 .B DISPLAY | |
| 270 Default X device to put edit frame. | |
| 271 | |
| 272 .SH FILES | |
| 273 .PP | |
| 274 .TP 8 | |
| 275 .B /tmp/gsrv??? | |
| 276 (SYSV_IPC only) | |
| 277 .TP 8 | |
| 278 .B /tmp/gsrvdir???/gsrv | |
| 279 (unix domain sockets only) | |
| 280 .TP 8 | |
| 281 .B ~/.emacs | |
| 282 XEmacs customization file, see xemacs(1). | |
| 283 .SH SEE ALSO | |
| 284 .PP | |
| 285 .TP 8 | |
| 286 xauth(1X11), Xsecurity(1X11), gnuserv.el | |
| 287 .SH BUGS | |
| 288 .PP | |
| 289 NULs occurring in result strings don't get passed back to gnudoit properly. | |
| 290 | |
| 291 .SH AUTHOR. | |
| 292 Andy Norman (ange@hplb.hpl.hp.com), based heavily upon | |
| 293 etc/emacsclient.c, etc/server.c and lisp/server.el from the GNU Emacs | |
| 294 18.52 distribution. Various modifications from Bob Weiner (weiner@mot.com), | |
| 295 Darrell Kindred (dkindred@cmu.edu), Arup Mukherjee (arup@cmu.edu), Ben | |
| 296 Wing (ben@xemacs.org) and Hrvoje Niksic (hniksic@xemacs.org). |