home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / u_man / cat1 / X11 / proxymngr.z / proxymngr
Encoding:
Text File  |  2002-10-03  |  10.9 KB  |  265 lines
  1.  
  2.  
  3.  
  4.      PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))        PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           proxymngr - proxy manager service
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           pppprrrrooooxxxxyyyymmmmnnnnggggrrrr [----ccccoooonnnnffffiiiigggg _f_i_l_e_n_a_m_e] [----ttttiiiimmmmeeeeoooouuuutttt _s_e_c_o_n_d_s] [----rrrreeeettttrrrriiiieeeessss #]
  13.           [----vvvveeeerrrrbbbboooosssseeee]
  14.  
  15.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  16.           The proxy manager (proxymngr) is responsible for resolving
  17.           requests from xfindproxy (and other similar clients),
  18.           starting new proxies when appropriate, and keeping track of
  19.           all of the available proxy services.  The proxy manager
  20.           strives to reuse existing proxies whenever possible.
  21.  
  22.           There are two types of proxies that the proxy manager deals
  23.           with, _m_a_n_a_g_e_d and _u_n_m_a_n_a_g_e_d proxies.
  24.  
  25.           A _m_a_n_a_g_e_d proxy is a proxy that is started ``on demand'' by
  26.           the proxy manager.
  27.  
  28.           An _u_n_m_a_n_a_g_e_d proxy, on the other hand, is started either at
  29.           system boot time, or manually by a system administrator.
  30.           The proxy manager is made aware of its existence, but no
  31.           attempt is made by the proxy manager to start unmanaged
  32.           proxies.
  33.  
  34.           The command line options that can be specified to pppprrrrooooxxxxyyyymmmmnnnnggggrrrr
  35.           are:
  36.  
  37.           ----ccccoooonnnnffffiiiigggg Used to override the default proxymngr config file.
  38.                   See below for more details about the config file.
  39.  
  40.           ----ttttiiiimmmmeeeeoooouuuutttt
  41.                   Sets the number of seconds between attempts made by
  42.                   the proxy manager to find an unmanaged proxy.  The
  43.                   default is 10.
  44.  
  45.           ----rrrreeeettttrrrriiiieeeessss
  46.                   Sets the maximum number of retries made by the proxy
  47.                   manager to find an an unmanaged proxy.  The default
  48.                   is 3.
  49.  
  50.           ----vvvveeeerrrrbbbboooosssseeee
  51.                   Causes various debugging and tracing records to be
  52.                   displayed as requests are received and proxies are
  53.                   started.
  54.  
  55.      RRRRuuuunnnnnnnniiiinnnngggg tttthhhheeee PPPPrrrrooooxxxxyyyy MMMMaaaannnnaaaaggggeeeerrrr
  56.           While it is possible to start the proxy manager by hand, a
  57.           single proxy manager can manage proxies for many users, so
  58.           it is most effective to configure it as a system daemon.  To
  59.           configure the proxy manager daemon to be started at system
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))        PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))
  71.  
  72.  
  73.  
  74.           startup and stopped at system shutdown, execute the command:
  75.  
  76.                chkconfig proxymngr on
  77.  
  78.           To stop the proxy manager daemon on a running system,
  79.           execute the command:
  80.  
  81.                /etc/init.d/proxymngr stop
  82.  
  83.           Be aware that stopping the proxy manager will normally kill
  84.           all managed proxies as well.
  85.  
  86.           To start the proxy manager daemon on a running system,
  87.           execute the command:
  88.  
  89.                /etc/init.d/proxymngr start
  90.  
  91.           Local users on the system where the proxy manager is running
  92.           can configure xfindproxy to access the proxy manager daemon
  93.           by setting the following variable in their shell
  94.           environment:
  95.  
  96.                PROXY_MANAGER=local/proxyhost:/tmp/.ICE-unix/6500,tcp/proxyhost:6500
  97.  
  98.           where "proxyhost" is the network name of the system where
  99.           the proxy manager is running.  Remote users can access the
  100.           proxy manager by using the latter address:
  101.  
  102.                PROXY_MANAGER=tcp/proxyhost:6500
  103.  
  104.           An alternative to using the shell environment variable is to
  105.           specify either address using the ----mmmmaaaannnnaaaaggggeeeerrrr option to
  106.           xfindproxy:
  107.  
  108.                xfindproxy -manager tcp/proxyhost:6500 ...
  109.  
  110.      PPPPrrrrooooxxxxyyyy MMMMaaaannnnaaaaggggeeeerrrr CCCCoooonnnnffffiiiigggg FFFFiiiilllleeee
  111.           The proxy manager maintains a local configuration file
  112.           describing the proxy services available.  This configuration
  113.           file is installed in /usr/lib/X11/proxymngr/pmconfig during
  114.           the installation of proxymngr.  The location of the
  115.           configuration file can be overwritten using the ----ccccoooonnnnffffiiiigggg
  116.           command line option.
  117.  
  118.           Aside from lines starting with an exclamation point for
  119.           comments, each line of the configuration file describes
  120.           either an unmanaged or managed proxy service.
  121.  
  122.           For unmanaged proxies, the format is:
  123.  
  124.                <service-name> unmanaged <proxy-address>
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))        PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))
  137.  
  138.  
  139.  
  140.           service-name is the name of the unmanaged proxy service, and
  141.           must not contain any spaces, for example ``XFWP''.
  142.           service-name is case insenstive.
  143.  
  144.           proxy-address is the network address of the unmanaged proxy.
  145.           The format of the address is specific to the service-name.
  146.           For example, for the ``XFWP'' service, the proxy-address
  147.           might be ``firewall.x.org:100''.
  148.  
  149.           If there is more than one entry in the config file with the
  150.           same unmanaged service-name, the proxy manager will try to
  151.           use the proxies in the order presented in the config file.
  152.  
  153.           For managed proxies, the format is:
  154.  
  155.                <service-name> managed <command-to-start-proxy>
  156.  
  157.           service-name is the name of the managed proxy service, and
  158.           must not contain any spaces, for example ``LBX''.  service-
  159.           name is case insensitive.
  160.  
  161.           command-to-start-proxy is the command executed by the proxy
  162.           manager to start a new instance of the proxy.  If command-
  163.           to-start-proxy contains spaces, the complete command should
  164.           be surrounded by single quotes.  If desired, command-to-
  165.           start-proxy can be used to start a proxy on a remote
  166.           machine.  The specifics of the remote execution method used
  167.           to do this is not specified here.
  168.  
  169.      EEEEXXXXAAAAMMMMPPPPLLLLEEEE
  170.           Here is a sample configuration file:
  171.  
  172.                ! proxy manager config file
  173.                !
  174.                ! Each line has the format:
  175.                !    <serviceName> managed <startCommand>
  176.                !        or
  177.                !    <serviceName> unmanaged <proxyAddress>
  178.                !
  179.                lbx managed /usr/bin/X11/lbxproxy
  180.                !
  181.                ! substitute site-specific info
  182.                xfwp unmanaged firewall:4444
  183.  
  184.  
  185.      PPPPRRRROOOOXXXXYYYY MMMMAAAANNNNAAAAGGGGEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  186.           When the proxy manager gets a request from xfindproxy (or
  187.           another similar client), its course of action will depend on
  188.           the service-name in question.
  189.  
  190.           For a managed proxy service, the proxy manager will find out
  191.           if any of the already running proxies for this service can
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 10/3/02)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))       XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))        PPPPRRRROOOOXXXXYYYYMMMMNNNNGGGGRRRR((((1111))))
  203.  
  204.  
  205.  
  206.           handle a new request.  If not, the proxy manager will
  207.           attempt to start up a new instance of the proxy (using the
  208.           command-to-start-proxy found in the config file).  If that
  209.           fails, an error will be returned to the caller.
  210.  
  211.           For an unmanaged proxy service, the proxy manager will look
  212.           in the config file to find all unmanaged proxies for this
  213.           service.  If there is more than one entry in the config file
  214.           with the same unmanaged service-name, the proxy manager will
  215.           try to use the proxies in the order presented in the config
  216.           file.  If none of the unmanged proxies can satisfy the
  217.           request, the proxy manager will timeout for a configurable
  218.           amount of time (specified by ----ttttiiiimmmmeeeeoooouuuutttt or default of 10) and
  219.           reattempt to find an unmanaged proxy willing to satisfy the
  220.           request.  The number of retries can be specified by the
  221.           ----rrrreeeettttrrrriiiieeeessss argument, or a default of 3 will be used.  If the
  222.           retries fail, the proxy manager has no choice but to return
  223.           an error to the caller (since the proxy manager can not
  224.           start unmanaged proxy services).
  225.  
  226.      BBBBUUUUGGGGSSSS
  227.           proxy manager listen port should be configurable.
  228.  
  229.           ----ttttiiiimmmmeeeeoooouuuutttt and ----rrrreeeettttrrrriiiieeeessss is not implemented in proxymngr.
  230.  
  231.           proxymngr does not utilize the ``options'' and ``host''
  232.           fields in the proxy management protocol GetProxyAddr
  233.           request.
  234.  
  235.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  236.           xfindproxy (1), xfwp (1), Proxy Management Protocol spec
  237.           V1.0
  238.  
  239.      AAAAUUUUTTTTHHHHOOOORRRR
  240.           Ralph Mor, X Consortium
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 10/3/02)
  262.  
  263.  
  264.  
  265.