Debian Codegraph @

cextern/xpa/man/mann/xpamethod.n

raw
1 .\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 . de IX
53 . tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 . nr % 0
56 . rr F
57 .\}
58 .el \{\
59 . de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
66 .if n \{\
67 . ds #H 0
68 . ds #V .8m
69 . ds #F .3m
70 . ds #[ \f1
71 . ds #] \fP
72 .\}
73 .if t \{\
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 . ds #V .6m
76 . ds #F 0
77 . ds #[ \&
78 . ds #] \&
79 .\}
80 . \" simple accents for nroff and troff
81 .if n \{\
82 . ds ' \&
83 . ds ` \&
84 . ds ^ \&
85 . ds , \&
86 . ds ~ ~
87 . ds /
88 .\}
89 .if t \{\
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 . ds : e
114 . ds 8 ss
115 . ds o a
116 . ds d- d\h'-1'\(ga
117 . ds D- D\h'-1'\(hy
118 . ds th \o'bp'
119 . ds Th \o'LP'
120 . ds ae ae
121 . ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "xpamethod n"
127 .TH xpamethod n "July 23, 2013" "version 2.1.15" "SAORD Documentation"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 \&\fBXPAMethod: \s-1XPA\s0 Communication Methods\fR
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 \&\s-1XPA\s0 supports both inet and unix (local) socket communication.
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 \&\s-1XPA\s0 uses sockets for communication between processes. It supports
140 three methods of socket communication: inet, localhost, and unix. In
141 general, the same method should be employed for all \s-1XPA\s0 processes in a
142 session and the global environment variable \s-1XPA_METHOD\s0 should be used
143 to set up the desired method. By default, the preferred method is
144 \&\*(L"inet\*(R", which is appropriate for most users. You can set up a
145 different method by typing something like:
146 .PP
147 .Vb 3
148 \& setenv XPA_METHOD local # unix csh
149 \& XPA_METHOD=local; export XPA_METHOD # unix sh, bash, windows/cygwin
150 \& set XPA_METHOD=localhost # dos/windows
151 .Ve
152 .PP
153 The options for \s-1XPA_METHOD\s0 are: \fBinet\fR, \fBunix\fR (or
154 \&\fBlocal\fR), and \fBlocalhost\fR. On Unix machines, this
155 environment setup command can be placed in your shell init file
156 (.cshrc, .profile, .bashrc, etc.) On Windows platforms, it can be
157 placed in your \s-1AUTOEXEC\s0.BAT file (I think!).
158 .PP
159 By default, \fBinet\fR sockets are used by \s-1XPA\s0. These are the standard
160 Internet sockets that are used by programs such as Netscape,
161 ftp. etc. Inet sockets utilize the \s-1IP\s0 address of the given machine and
162 a (usually random) port number to communicate between processes on the
163 same machine or between different machines on the Internet. (Note that
164 \&\s-1XPA\s0 has an Access Control mechanism to
165 prevent unauthorized access of \s-1XPA\s0 access points by other computers on
166 the Net). For users connected to the Internet, this usually is the
167 appropriate communication method. For more information about setting
168 up \s-1XPA\s0 communication between machines, see
169 Communication Between Machines.
170 .PP
171 In you are using \s-1XPA\s0 on a machine without an Internet connection, then
172 inet sockets are not appropriate. In fact, an \s-1XPA\s0 process often will
173 hang for many seconds while waiting for a response from the Domain
174 Name Service (\s-1DNS\s0) when using inet sockets. Instead of inet sockets,
175 users on Unix platforms can also use \fBunix\fR sockets (also known
176 as local sockets). These sockets are based on the local file system
177 and do not make use of the \s-1DNS\s0. They generally are considered to be
178 faster than inet sockets, but they are not implemented under
179 Windows. Use local sockets as a first resort if you are on a Unix
180 machine that is not connected to the Internet.
181 .PP
182 Users not connected to the Internet also can use \fBlocalhost\fR
183 sockets. These are also inet-type sockets but the \s-1IP\s0 address used for
184 the local machine is the \fBlocalhost\fR address, 0x7F000001, instead
185 of the real \s-1IP\s0 of the machine. Depending on how sockets are set up for
186 a given platform, communication with the \s-1DNS\s0 usually is not required in
187 this case (though of course, \s-1XPA\s0 cannot interact with other machines).
188 The localhost method will generally work on both Unix and Windows
189 platforms, but whether the \s-1DNS\s0 is required or not is subject to
190 individual configurations.
191 .PP
192 A final warning/reminder: if your XPA-enabled server hangs at startup
193 time and your \s-1XPA_METHOD\s0 is \fBinet\fR, the problem probably is
194 related to an incorrect Internet configuration. This can be confirmed
195 by using the \fBunix\fR method or (usually) the \fBlocalhost\fR
196 method. You can use these alternate methods if other hosts do not need
197 access to the \s-1XPA\s0 server.
198 .SH "SEE ALSO"
199 .IX Header "SEE ALSO"
200 See xpa(n) for a list of \s-1XPA\s0 help pages