home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat1 / xauth.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  9.1 KB  |  265 lines

  1.  
  2.  
  3.  
  4. XAUTH(1)                         XAUTH(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        xauth - X authority file utility
  9.  
  10. SSYYNNOOPPSSIISS
  11.        xxaauutthh [ --ff _a_u_t_h_f_i_l_e ] [ --vvqqiibb ] [ _c_o_m_m_a_n_d _a_r_g _._._. ]
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.        The  _x_a_u_t_h  program is used to edit and display the autho-
  15.        rization information used in connecting to the  X  server.
  16.        This  program  is  usually  used     to extract authorization
  17.        records from one machine and merge them in on another  (as
  18.        is the case when using remote logins or granting access to
  19.        other users).  Commands (described below) may  be  entered
  20.        interactively,  on  the _x_a_u_t_h command line, or in scripts.
  21.        Note that this program does  nnoott     contact  the  X  server.
  22.        Normally     _x_a_u_t_h    is  not used to create the authority file
  23.        entry in the first place; _x_d_m does that.
  24.  
  25. OOPPTTIIOONNSS
  26.        The following options may be used with _x_a_u_t_h.  They may be
  27.        given  individually  (e.g.,  _-_q _-_i) or may combined (e.g.,
  28.        _-_q_i).
  29.  
  30.        --ff _a_u_t_h_f_i_l_e
  31.            This option specifies the name  of  the    authority
  32.            file  to use.  By default, _x_a_u_t_h will use the file
  33.            specified by the XAUTHORITY  environment     variable
  34.            or _._X_a_u_t_h_o_r_i_t_y in the user's home directory.
  35.  
  36.        --qq      This  option  indicates    that _x_a_u_t_h should operate
  37.            quietly and not print unsolicited status messages.
  38.            This  is     the  default  if  an _x_a_u_t_h command is is
  39.            given on the command line or if the standard  out-
  40.            put is not directed to a terminal.
  41.  
  42.        --vv      This  option  indicates    that _x_a_u_t_h should operate
  43.            verbosely and print status messages indicating the
  44.            results    of  various  operations     (e.g.,     how many
  45.            records have been read in or written  out).   This
  46.            is  the    default if _x_a_u_t_h is reading commands from
  47.            its standard input  and    its  standard  output  is
  48.            directed to a terminal.
  49.  
  50.        --ii      This option indicates that _x_a_u_t_h should ignore any
  51.            authority file locks.  Normally, _x_a_u_t_h will refuse
  52.            to read or edit any authority files that have been
  53.            locked by other programs (usually _x_d_m  or  another
  54.            _x_a_u_t_h).
  55.  
  56.        --bb      This option indicates that _x_a_u_t_h should attempt to
  57.            break any authority file locks before  proceeding.
  58.            Use this option only to clean up stale locks.
  59.  
  60.  
  61.  
  62.  
  63.  
  64. X Version 11           Release 6.1                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XAUTH(1)                         XAUTH(1)
  71.  
  72.  
  73. CCOOMMMMAANNDDSS
  74.        The following commands may be used to manipulate authority
  75.        files:
  76.  
  77.        aadddd _d_i_s_p_l_a_y_n_a_m_e _p_r_o_t_o_c_o_l_n_a_m_e _h_e_x_k_e_y
  78.            An authorization entry for the  indicated  display
  79.            using  the given protocol and key data is added to
  80.            the authorization file.    The data is specified  as
  81.            an  even-lengthed  string  of  hexadecimal digits,
  82.            each pair representing one octet.  The first digit
  83.            of  each pair gives the most significant 4 bits of
  84.            the octet, and the second digit of the pair  gives
  85.            the  least  significant 4 bits.    For example, a 32
  86.            character hexkey would represent a 128-bit  value.
  87.            A protocol name consisting of just a single period
  88.            is  treated  as    an  abbreviation  for  _M_I_T_-_M_A_G_I_C_-
  89.            _C_O_O_K_I_E_-_1.
  90.  
  91.        [[nn]]eexxttrraacctt _f_i_l_e_n_a_m_e _d_i_s_p_l_a_y_n_a_m_e_._._.
  92.            Authorization  entries  for  each of the specified
  93.            displays are written to the  indicated  file.   If
  94.            the  _n_e_x_t_r_a_c_t  command  is  used,  the entries are
  95.            written in a  numeric  format  suitable    for  non-
  96.            binary  transmission  (such  as    secure electronic
  97.            mail).  The extracted entries can be read back  in
  98.            using the _m_e_r_g_e and _n_m_e_r_g_e commands.  If the file-
  99.            name consists of just a single dash,  the  entries
  100.            will be written to the standard output.
  101.  
  102.        [[nn]]lliisstt [_d_i_s_p_l_a_y_n_a_m_e...]
  103.            Authorization  entries  for  each of the specified
  104.            displays (or all if no  displays     are  named)  are
  105.            printed on the standard output.    If the _n_l_i_s_t com-
  106.            mand is used, entries will be shown in the numeric
  107.            format  used  by     the _n_e_x_t_r_a_c_t command; otherwise,
  108.            they are shown in a textual format.  Key     data  is
  109.            always  displayed  in the hexadecimal format given
  110.            in the description of the _a_d_d command.
  111.  
  112.        [[nn]]mmeerrggee [_f_i_l_e_n_a_m_e...]
  113.            Authorization entries are read from the    specified
  114.            files   and  are     merged     into  the  authorization
  115.            database,  superceding    any   matching     existing
  116.            entries.     If  the  _n_m_e_r_g_e  command  is  used,  the
  117.            numeric format given in    the  description  of  the
  118.            _e_x_t_r_a_c_t    command     is used.  If a filename consists
  119.            of just a single dash, the standard input will  be
  120.            read if it hasn't been read before.
  121.  
  122.        rreemmoovvee _d_i_s_p_l_a_y_n_a_m_e...
  123.            Authorization  entries matching the specified dis-
  124.            plays are removed from the authority file.
  125.  
  126.  
  127.  
  128.  
  129.  
  130. X Version 11           Release 6.1                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XAUTH(1)                         XAUTH(1)
  137.  
  138.  
  139.        ssoouurrccee _f_i_l_e_n_a_m_e
  140.            The specified file is treated as a script contain-
  141.            ing  _x_a_u_t_h  commands  to execute.  Blank lines and
  142.            lines beginning with a sharp sign (#) are ignored.
  143.            A single dash may be used to indicate the standard
  144.            input, if it hasn't already been read.
  145.  
  146.        iinnffoo    Information  describing    the  authorization  file,
  147.            whether    or  not     any  changes have been made, and
  148.            from  where  _x_a_u_t_h  commands  are  being     read  is
  149.            printed on the standard output.
  150.  
  151.        eexxiitt    If any modifications have been made, the authority
  152.            file is written out (if allowed), and the  program
  153.            exits.    An  end of file is treated as an implicit
  154.            _e_x_i_t command.
  155.  
  156.        qquuiitt    The program  exits,  ignoring  any  modifications.
  157.            This  may  also    be  accomplished  by pressing the
  158.            interrupt character.
  159.  
  160.        hheellpp [[_s_t_r_i_n_g]]
  161.            A description of all commands that begin with  the
  162.            given  string  (or  all    commands  if no string is
  163.            given) is printed on the standard output.
  164.  
  165.        ??       A short list of the valid commands is  printed  on
  166.            the standard output.
  167.  
  168. DDIISSPPLLAAYY NNAAMMEESS
  169.        Display    names for the _a_d_d, _[_n_]_e_x_t_r_a_c_t, _[_n_]_l_i_s_t, _[_n_]_m_e_r_g_e,
  170.        and _r_e_m_o_v_e commands use the same     format     as  the  DISPLAY
  171.        environment  variable and the common _-_d_i_s_p_l_a_y command line
  172.        argument.   Display-specific  information  (such     as   the
  173.        screen  number) is unnecessary and will be ignored.  Same-
  174.        machine connections (such as  local-host     sockets,  shared
  175.        memory,    and the Internet Protocol hostname _l_o_c_a_l_h_o_s_t) are
  176.        referred to as _h_o_s_t_n_a_m_e/unix:_d_i_s_p_l_a_y_n_u_m_b_e_r so  that  local
  177.        entries    for  different    machines  may  be  stored  in one
  178.        authority file.
  179.  
  180. EEXXAAMMPPLLEE
  181.        The most common use for _x_a_u_t_h is to extract the entry  for
  182.        the current display, copy it to another machine, and merge
  183.        it into the user's authority file on the remote machine:
  184.  
  185.            %  xauth extract - $DISPLAY | rsh otherhost xauth merge -
  186.  
  187. EENNVVIIRROONNMMEENNTT
  188.        This _x_a_u_t_h program uses the  following  environment  vari-
  189.        ables:
  190.  
  191.        XXAAUUTTHHOORRIITTYY
  192.            to  get    the  name of the authority file to use if
  193.  
  194.  
  195.  
  196. X Version 11           Release 6.1                3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XAUTH(1)                         XAUTH(1)
  203.  
  204.  
  205.            the _-_f option isn't used.
  206.  
  207.        HHOOMMEE    to get the user's  home    directory  if  XAUTHORITY
  208.            isn't defined.
  209.  
  210. FFIILLEESS
  211.        _$_H_O_M_E_/_._X_a_u_t_h_o_r_i_t_y
  212.            default     authority   file   if    XAUTHORITY  isn't
  213.            defined.
  214.  
  215. BBUUGGSS
  216.        Users that have unsecure networks should take care to  use
  217.        encrypted  file    transfer mechanisms to copy authorization
  218.        entries    between     machines.   Similarly,     the   _M_I_T_-_M_A_G_I_C_-
  219.        _C_O_O_K_I_E_-_1     protocol is not very useful in unsecure environ-
  220.        ments.  Sites that are interested in  additional     security
  221.        may need to use encrypted authorization mechanisms such as
  222.        Kerberos.
  223.  
  224.        Spaces are currently not allowed     in  the  protocol  name.
  225.        Quoting could be added for the truly perverse.
  226.  
  227. AAUUTTHHOORR
  228.        Jim Fulton, MIT X Consortium
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262. X Version 11           Release 6.1                4
  263.  
  264.  
  265.