1PROXYMNGR(1) General Commands Manual PROXYMNGR(1)
2
6 proxymngr - proxy manager service
7
9 proxymngr [-config filename] [-timeout seconds] [-retries #] [-verbose]
10
12 The proxy manager (proxymngr) is responsible for resolving requests
13 from xfindproxy (and other similar clients), starting new proxies when
14 appropriate, and keeping track of all of the available proxy services.
15 The proxy manager strives to reuse existing proxies whenever possible.
16 There are two types of proxies that the proxy manager deals with, man‐
18 aged and unmanaged proxies.
19 A managed proxy is a proxy that is started ``on demand'' by the proxy
21 manager.
22 An unmanaged proxy, on the other hand, is started either at system boot
24 time, or manually by a system administrator. The proxy manager is made
25 aware of its existence, but no attempt is made by the proxy manager to
26 start unmanaged proxies.
27 The command line options that can be specified to proxymngr are:
29 -config Used to override the default proxymngr config file. See below
31 for more details about the config file.
32 -timeout
34 Sets the number of seconds between attempts made by the proxy
35 manager to find an unmanaged proxy. The default is 10.
36 -retries
38 Sets the maximum number of retries made by the proxy manager to
39 find an an unmanaged proxy. The default is 3.
40 -verbose
42 Causes various debugging and tracing records to be displayed as
43 requests are received and proxies are started.
44
46 The proxy manager maintains a local configuration file describing the
47 proxy services available. This configuration file is installed in
48 /usr/lib/X11/proxymngr/pmconfig during the installation of proxymngr.
49 The location of the configuration file can be overwritten using the
50 -config command line option.
51 Aside from lines starting with an exclamation point for comments, each
53 line of the configuration file describes either an unmanaged or managed
54 proxy service.
55 For unmanaged proxies, the format is:
57 <service-name> unmanaged <proxy-address>
59 service-name is the name of the unmanaged proxy service, and must not
61 contain any spaces, for example ``XFWP''. service-name is case insen‐
62 sitive.
63 proxy-address is the network address of the unmanaged proxy. The for‐
65 mat of the address is specific to the service-name. For example, for
66 the ``XFWP'' service, the proxy-address might be ``fire‐
67 wall.x.org:100''.
68 If there is more than one entry in the config file with the same unman‐
70 aged service-name, the proxy manager will try to use the proxies in the
71 order presented in the config file.
72 For managed proxies, the format is:
74 <service-name> managed <command-to-start-proxy>
76 service-name is the name of the managed proxy service, and must not
78 contain any spaces, for example ``LBX''. service-name is case insensi‐
79 tive.
80 command-to-start-proxy is the command executed by the proxy manager to
82 start a new instance of the proxy. If command-to-start-proxy contains
83 spaces, the complete command should be surrounded by single quotes. If
84 desired, command-to-start-proxy can be used to start a proxy on a
85 remote machine. The specifics of the remote execution method used to
86 do this is not specified here.
87
89 Here is a sample configuration file:
90 ! proxy manager config file
92 !
93 ! Each line has the format:
94 ! <serviceName> managed <startCommand>
95 ! or
96 ! <serviceName> unmanaged <proxyAddress>
97 !
98 lbx managed /usr/bin/lbxproxy
99 !
100 ! substitute site-specific info
101 xfwp unmanaged firewall:4444
102
104 When the proxy manager gets a request from xfindproxy (or another simi‐
105 lar client), its course of action will depend on the service-name in
106 question.
107 For a managed proxy service, the proxy manager will find out if any of
109 the already running proxies for this service can handle a new request.
110 If not, the proxy manager will attempt to start up a new instance of
111 the proxy (using the command-to-start-proxy found in the config file).
112 If that fails, an error will be returned to the caller.
113 For an unmanaged proxy service, the proxy manager will look in the con‐
115 fig file to find all unmanaged proxies for this service. If there is
116 more than one entry in the config file with the same unmanaged service-
117 name, the proxy manager will try to use the proxies in the order pre‐
118 sented in the config file. If none of the unmanaged proxies can sat‐
119 isfy the request, the proxy manager will timeout for a configurable
120 amount of time (specified by -timeout or default of 10) and reattempt
121 to find an unmanaged proxy willing to satisfy the request. The number
122 of retries can be specified by the -retries argument, or a default of 3
123 will be used. If the retries fail, the proxy manager has no choice but
124 to return an error to the caller (since the proxy manager can not start
125 unmanaged proxy services).
126
128 proxy manager listen port should be configurable.
129 -timeout and -retries is not implemented in proxymngr.
131 proxymngr does not utilize the ``options'' and ``host'' fields in the
133 proxy management protocol GetProxyAddr request.
134
136 xfindproxy (1), xfwp (1), Proxy Management Protocol spec V1.0
137
139 Ralph Mor, X Consortium
140X Version 11 proxymngr 1.0.1 PROXYMNGR(1)