home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-bin / x11r6.1 / man / cat1 / xman.0 < prev    next >
Encoding:
Text File  |  1996-10-17  |  16.2 KB  |  529 lines
  1.  
  2.  
  3.  
  4. XMAN(1)                              XMAN(1)
  5.  
  6.  
  7. NNAAMMEE
  8.        xman - Manual page display program for the X Window System
  9.  
  10. SSYYNNOOPPSSIISS
  11.        xxmmaann [ _-_o_p_t_i_o_n_s ... ]
  12.  
  13. DDEESSCCRRIIPPTTIIOONN
  14.        _X_m_a_n is a manual page browser.  The default  size  of  the
  15.        initial _x_m_a_n window is small so that you can leave it run-
  16.        ning throughout your entire login session.  In the initial
  17.        window  there are three options: _H_e_l_p will pop up a window
  18.        with on-line help, _Q_u_i_t will exit, and  _M_a_n_u_a_l  _P_a_g_e  will
  19.        pop  up a window with a manual page browser in it.  Typing
  20.        Control-S will pop up a window prompting     for  a     specific
  21.        manual  page  to     display.   You may display more than one
  22.        manual page browser window at a time from a single  execu-
  23.        tion of _x_m_a_n.
  24.  
  25.        For further information on using _x_m_a_n, please read the on-
  26.        line help information.  Most of this manual  will  discuss
  27.        customization of _x_m_a_n.
  28.  
  29. OOPPTTIIOONNSS
  30.        Xman  supports all standard Toolkit command line arguments
  31.        (see _X(1)).  The following additional arguments    are  sup-
  32.        ported.
  33.  
  34.  
  35.        --hheellppffiillee _f_i_l_e_n_a_m_e
  36.           Specifies a helpfile to use other than the default.
  37.  
  38.        --bbootthhsshhoowwnn
  39.           Allows both the manual page and manual directory to
  40.           be on the screen at the same time.
  41.  
  42.        --nnoottooppbbooxx
  43.           Starts  without the Top Menu with the three buttons
  44.           in it.
  45.  
  46.        --ggeeoommeettrryy _W_x_H_+_X_+_Y
  47.           Sets the size and location of the Top Menu with the
  48.           three buttons in it.
  49.  
  50.        --ppaaggeessiizzee _W_x_H_+_X_+_Y
  51.           Sets the size and location of all the Manual Pages.
  52.  
  53. CCUUSSTTOOMMIIZZIINNGG XXMMAANN
  54.        _X_m_a_n allows customization of both the  directories  to  be
  55.        searched     for  manual pages, and the name that each direc-
  56.        tory will map to in the _S_e_c_t_i_o_n_s     menu.     Xman  determines
  57.        which  directories  it  will search by reading the _M_A_N_P_A_T_H
  58.        environment variable.  If no _M_A_N_P_A_T_H  is     found    then  the
  59.        directory  is /usr/man is searched on POSIX systems.  This
  60.        environment is expected to be a    colon-separated     list  of
  61.  
  62.  
  63.  
  64. X Version 11            Release 6                1
  65.  
  66.  
  67.  
  68.  
  69.  
  70. XMAN(1)                              XMAN(1)
  71.  
  72.  
  73.        directories for xman to search.
  74.  
  75.        setenv MANPATH /mit/kit/man:/usr/man
  76.  
  77.        By  default, _x_m_a_n will search each of the following direc-
  78.        tories (in each of the directories specified in the  users
  79.        MANPATH)     for manual pages.  If manual pages exist in that
  80.        directory then they are added to list of manual pages  for
  81.        the  corresponding  menu     item.     A menu item is only dis-
  82.        played for those sections  that    actually  contain  manual
  83.        pages.
  84.  
  85.        Directory      Section Name
  86.        ---------      ------------
  87.        man1          (1) User Commands
  88.        man2          (2) System Calls
  89.        man3          (3) Subroutines
  90.        man4          (4) Devices
  91.        man5          (5) File Formats
  92.        man6          (6) Games
  93.        man7          (7) Miscellaneous
  94.        man8          (8) Sys. Administration
  95.        manl          (l) Local
  96.        mann          (n) New
  97.        mano          (o) Old
  98.  
  99.        For  instance,  a user has three directories in her manual
  100.        path and each contain a directory called _m_a_n_3.  All  these
  101.        manual  pages  will  appear alphabetically sorted when the
  102.        user selects the menu item  called  _(_3_)    _S_u_b_r_o_u_t_i_n_e_s.   If
  103.        there  is  no directory called _m_a_n_o in any of the directo-
  104.        ries in her MANPATH, or there are no manual pages  in  any
  105.        of  the    directories called _m_a_n_o then no menu item will be
  106.        displayed for the section called _(_o_) _O_l_d.
  107.  
  108. TTHHEE MMAANNDDEESSCC FFIILLEE
  109.        By using the _m_a_n_d_e_s_c file a user or system manager is able
  110.        to  more closely control which manual pages will appear in
  111.        each of the sections represented by menu items in the _S_e_c_-
  112.        _t_i_o_n_s  menu.   This  functionality  is only available on a
  113.        section by section basis, and individual manual pages  may
  114.        not  be handled in this manner.    (Although generous use of
  115.        symbolic links -- see _l_n(1) -- will allow almost any  con-
  116.        figuration you can imagine.)
  117.  
  118.        The  format of the mandesc file is a character followed by
  119.        a label.     The character determines which of  the     sections
  120.        will be added under this label.    For instance suppose that
  121.        you would like to create an extra menu item that     contains
  122.        all programmer subroutines.  This label should contain all
  123.        manual pages in both sections two and three.  The  _m_a_n_d_e_s_c
  124.        file would look like this:
  125.  
  126.        2Programmer Subroutines
  127.  
  128.  
  129.  
  130. X Version 11            Release 6                2
  131.  
  132.  
  133.  
  134.  
  135.  
  136. XMAN(1)                              XMAN(1)
  137.  
  138.  
  139.        3Programmer Subroutines
  140.  
  141.        This  will add a menu item to the _S_e_c_t_i_o_n_s menu that would
  142.        bring up a listing of all manual pages in sections two and
  143.        three  of  the  Programmers Manual.  Since the label names
  144.        are _e_x_a_c_t_l_y the same they will be added to the  same  sec-
  145.        tion.  Note,  however,  that  the  original sections still
  146.        exist.
  147.  
  148.        If you want to completely ignore the default sections in a
  149.        manual directory then add the line:
  150.  
  151.        no default sections
  152.  
  153.        anywhere     in  your  mandesc  file.   This  keeps xman from
  154.        searching the default manual sections  _I_n  _t_h_a_t    _d_i_r_e_c_t_o_r_y
  155.        _o_n_l_y.   As  an  example,     suppose  you want to do the same
  156.        thing as above, but you don't think that it is  useful  to
  157.        have  the _S_y_s_t_e_m _C_a_l_l_s or _S_u_b_r_o_u_t_i_n_e_s sections any longer.
  158.        You would need to duplicate the default entries,     as  well
  159.        as adding your new one.
  160.  
  161.        no default sections
  162.        1(1) User Commands
  163.        2Programmer Subroutines
  164.        3Programmer Subroutines
  165.        4(4) Devices
  166.        5(5) File Formats
  167.        6(6) Games
  168.        7(7) Miscellaneous
  169.        8(8) Sys. Administration
  170.        l(l) Local
  171.        n(n) New
  172.        o(o) Old
  173.  
  174.        Xman   will   read   any     section  that    is  of    the  from
  175.        _m_a_n_<_c_h_a_r_a_c_t_e_r_>, where <character> is  an     upper    or  lower
  176.        case  letter  (they  are     treated distinctly) or a numeral
  177.        (0-9).  Be warned, however, that man(1) and catman(8) will
  178.        not search directories that are non-standard.
  179.  
  180. WWIIDDGGEETTSS
  181.        In  order  to  specify resources, it is useful to know the
  182.        hierarchy of the widgets which compose _x_m_a_n.  In the nota-
  183.        tion  below, indentation indicates hierarchical structure.
  184.        The widget class name is given first, followed by the wid-
  185.        get instance name.
  186.  
  187.        Xman xman _(_T_h_i_s _w_i_d_g_e_t _i_s _n_e_v_e_r _u_s_e_d_)
  188.         TopLevelShell  topBox
  189.          Form  form
  190.               Label  topLabel
  191.               Command  helpButton
  192.               Command  quitButton
  193.  
  194.  
  195.  
  196. X Version 11            Release 6                3
  197.  
  198.  
  199.  
  200.  
  201.  
  202. XMAN(1)                              XMAN(1)
  203.  
  204.  
  205.               Command  manpageButton
  206.          TransientShell     search
  207.               DialogWidgetClass     dialog
  208.                Label  label
  209.                Text     value
  210.                Command  manualPage
  211.                Command  apropos
  212.                Command  cancel
  213.          TransientShell     pleaseStandBy
  214.               Label  label
  215.         TopLevelShell  manualBrowser
  216.          Paned    Manpage_Vpane
  217.               Paned  horizPane
  218.                MenuButton  options
  219.                MenuButton  sections
  220.                Label  manualBrowser
  221.               Viewport    directory
  222.                List     directory
  223.                List     directory
  224.                .
  225.                . (one for each section,
  226.                .  created on the fly)
  227.                .
  228.               ScrollByLine  manualPage
  229.          SimpleMenu  optionMenu
  230.               SmeBSB  displayDirectory
  231.               SmeBSB  displayManualPage
  232.               SmeBSB  help
  233.               SmeBSB  search
  234.               SmeBSB  showBothScreens
  235.               SmeBSB  removeThisManpage
  236.               SmeBSB  openNewManpage
  237.               SmeBSB  showVersion
  238.               SmeBSB  quit
  239.          SimpleMenu  sectionMenu
  240.               SmeBSB  <name of section>
  241.                .
  242.                . (one for each section)
  243.                .
  244.          TransientShell     search
  245.               DialogWidgetClass     dialog
  246.                Label  label
  247.                Text     value
  248.                Command  manualPage
  249.                Command  apropos
  250.                Command  cancel
  251.          TransientShell     pleaseStandBy
  252.               Label  label
  253.          TransientShell     likeToSave
  254.               Dialog  dialog
  255.                Label  label
  256.                Text     value
  257.                Command  yes
  258.                Command  no
  259.  
  260.  
  261.  
  262. X Version 11            Release 6                4
  263.  
  264.  
  265.  
  266.  
  267.  
  268. XMAN(1)                              XMAN(1)
  269.  
  270.  
  271.         TopLevelShell  help
  272.          Paned    Manpage_Vpane
  273.               Paned  horizPane
  274.                MenuButton  options
  275.                MenuButton  sections
  276.                Label  manualBrowser
  277.               ScrollByLine  manualPage
  278.          SimpleMenu  optionMenu
  279.               SmeBSB  displayDirectory
  280.               SmeBSB  displayManualPage
  281.               SmeBSB  help
  282.               SmeBSB  search
  283.               SmeBSB  showBothScreens
  284.               SmeBSB  removeThisManpage
  285.               SmeBSB  openNewManpage
  286.               SmeBSB  showVersion
  287.               SmeBSB  quit
  288.  
  289.  
  290. AAPPPPLLIICCAATTIIOONN RREESSOOUURRCCEESS
  291.        _x_m_a_n  has  the  following  application-specific    resources
  292.        which allow customizations unique to _x_m_a_n.
  293.  
  294.  
  295.        mmaannuuaallFFoonnttNNoorrmmaall (Class FFoonntt)
  296.              The font to use for normal text  in  the
  297.              manual pages.
  298.  
  299.        mmaannuuaallFFoonnttBBoolldd (Class FFoonntt)
  300.              The  font  to    use  for bold text in the
  301.              manual pages.
  302.  
  303.        mmaannuuaallFFoonnttIIttaalliicc (Class FFoonntt)
  304.              The font to use for italic text  in  the
  305.              manual pages.
  306.  
  307.        ddiirreeccttoorryyFFoonnttNNoorrmmaall (Class FFoonntt)
  308.              The  font to use for the directory text.
  309.  
  310.        bbootthhSShhoowwnn (Class BBoooolleeaann)
  311.              Either     `true'     or  `false,'    specifies
  312.              whether  or not you want both the direc-
  313.              tory and the manual page shown at  start
  314.              up.
  315.  
  316.        ddiirreeccttoorryyHHeeiigghhtt (Class DDiirreeccttoorryyHHeeiigghhtt)
  317.              The  height  in pixels of the directory,
  318.              when the directory and the  manual  page
  319.              are shown simultaneously.
  320.  
  321.        ttooppCCuurrssoorr (Class CCuurrssoorr)
  322.              The cursor to use in the top box.
  323.  
  324.  
  325.  
  326.  
  327.  
  328. X Version 11            Release 6                5
  329.  
  330.  
  331.  
  332.  
  333.  
  334. XMAN(1)                              XMAN(1)
  335.  
  336.  
  337.        hheellppCCuurrssoorr (Class CCuurrssoorr)
  338.              The cursor to use in the help window.
  339.  
  340.        mmaannppaaggeeCCuurrssoorr (Class CCuurrssoorr)
  341.              The  cursor  to  use  in the manual page
  342.              window.
  343.  
  344.        sseeaarrcchhEEnnttrryyCCuurrssoorr (Class CCuurrssoorr)
  345.              The cursor to use in  the  search  entry
  346.              text widget.
  347.  
  348.        ppooiinntteerrCCoolloorr (Class FFoorreeggrroouunndd)
  349.              This  is  the    color  of all the cursors
  350.              (pointers) specified  above.    The  name
  351.              was  chosen to be compatible with xterm.
  352.  
  353.        hheellppFFiillee     (Class FFiillee)
  354.              Use this rather than the system  default
  355.              helpfile.
  356.  
  357.        ttooppBBooxx (Class BBoooolleeaann)
  358.              Either     `true'     or  `false,'  determines
  359.              whether  the  top  box     (containing  the
  360.              help, quit and manual page buttons) or a
  361.              manual page is     put  on  the  screen  at
  362.              start-up.  The default is true.
  363.  
  364.        vveerrttiiccaallLLiisstt (Class BBoooolleeaann)
  365.              Either     `true'     or  `false,'  determines
  366.              whether the directory listing is  verti-
  367.              cally    or  horizontally  organized.  The
  368.              default is horizontal (false).
  369.  
  370. GGLLOOBBAALL AACCTTIIOONNSS
  371.        _X_m_a_n defines all user interaction through global     actions.
  372.        This  allows  the  user to modify the translation table of
  373.        any widget, and bind any event to  the  new  user  action.
  374.        The list of actions supported by _x_m_a_n are:
  375.  
  376.        GGoottooPPaaggee((_p_a_g_e)) When  used  in a manual page display window
  377.               this will allow the user to move between    a
  378.               directory     and  manual  page  display.  The
  379.               _p_a_g_e argument can be  either  DDiirreeccttoorryy  or
  380.               MMaannuuaallPPaaggee.
  381.  
  382.        QQuuiitt(())          This  action may be used anywhere, and will
  383.               exit xman.
  384.  
  385.        SSeeaarrcchh((_t_y_p_e,, _a_c_t_i_o_n))
  386.               Only useful when used in    a  search  popup,
  387.               this action will cause the search widget to
  388.               perform the named search type on the string
  389.               in  the  search  popup's value widget. This
  390.               action  will  also  pop  down  the   search
  391.  
  392.  
  393.  
  394. X Version 11            Release 6                6
  395.  
  396.  
  397.  
  398.  
  399.  
  400. XMAN(1)                              XMAN(1)
  401.  
  402.  
  403.               widget.  The  _t_y_p_e  argument  can be either
  404.               AApprrooppooss, MMaannppaaggee or CCaanncceell.  If  an  _a_c_t_i_o_n
  405.               of  OOppeenn is specified then xman will open a
  406.               new manual page to display the  results  of
  407.               the  search, otherwise xman will attempt to
  408.               display the results in the  parent  of  the
  409.               search popup.
  410.  
  411.        PPooppuuppHHeellpp(())    This  action may be used anywhere, and will
  412.               popup the help widget.
  413.  
  414.        PPooppuuppSSeeaarrcchh(())  This action may be used anywhere except  in
  415.               a     help  window.     It will cause the search
  416.               popup to become active and visible  on  the
  417.               screen, allowing the user search for a man-
  418.               ual page.
  419.  
  420.        CCrreeaatteeNNeewwMMaannppaaggee(())
  421.               This action may be used anywhere, and  will
  422.               create a new manual page display window.
  423.  
  424.        RReemmoovveeTThhiissMMaannppaaggee(())
  425.               This  action may be used in any manual page
  426.               or help display  window.     When  called  it
  427.               will  remove  the     window, and clean up all
  428.               resources associated with it.
  429.  
  430.        SSaavveeFFoorrmmaatttteeddPPaaggee((_a_c_t_i_o_n))
  431.               This action can only be used in  the  lliikkee--
  432.               TTooSSaavvee popup widget, and tells xman whether
  433.               to SSaavvee or CCaanncceell a save of the manual page
  434.               that has just been formatted.
  435.  
  436.        SShhoowwVVeerrssiioonn(())  This  action  may be called from any manual
  437.               page or help display window, and will cause
  438.               the  informational display line to show the
  439.               current version of xman.
  440.  
  441. FFIILLEESS
  442.        _<_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y_>/man<_c_h_a_r_a_c_t_e_r>
  443.  
  444.        _<_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y_>/cat<_c_h_a_r_a_c_t_e_r>
  445.  
  446.        _<_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y_>/mandesc
  447.  
  448.        <XRoot>/lib/X11/app-defaults/Xman
  449.                 specifies   required   resources.
  450.                 <XRoot> refers to the root of the
  451.                 X11 install tree.
  452.  
  453.        /tmp            _X_m_a_n creates temporary    files  in
  454.                 /tmp   for  all     unformatted  man
  455.                 pages and all apropos searches.
  456.  
  457.  
  458.  
  459.  
  460. X Version 11            Release 6                7
  461.  
  462.  
  463.  
  464.  
  465.  
  466. XMAN(1)                              XMAN(1)
  467.  
  468.  
  469. SSEEEE AALLSSOO
  470.        _X(1), _m_a_n(1), _a_p_r_o_p_o_s(1), _c_a_t_m_a_n(8), _A_t_h_e_n_a _W_i_d_g_e_t _S_e_t
  471.  
  472. EENNVVIIRROONNMMEENNTT
  473.        DDIISSPPLLAAYY          the default host and display to use.
  474.  
  475.        MMAANNPPAATTHH          the search path for manual pages.     Directo-
  476.               ries   are   separated   by   colons  (e.g.
  477.               /usr/man:/mit/kit/man:/foo/bar/man).
  478.  
  479.        XXEENNVVIIRROONNMMEENNTT   to get the name of  a  resource  file  that
  480.               overrides     the  global  resources stored in
  481.               the RESOURCE_MANAGER property.
  482.  
  483.        XXAAPPPPLLRREESSDDIIRR    A string that will have  ``Xman''     appended
  484.               to  it.    This string will be the full path
  485.               name of a     user  app-defaults  file  to  be
  486.               merged into the resource database after the
  487.               system app-defaults file,     and  before  the
  488.               resources that are attached to the display.
  489.               See _X_(_1_) for a full statement of rights and
  490.               permissions.
  491.  
  492. AAUUTTHHOORRSS
  493.        Chris  Peterson,     MIT  X     Consortium  from the V10 version
  494.        written by Barry Shein formerly of Boston University.
  495.  
  496.  
  497.  
  498.  
  499.  
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506.  
  507.  
  508.  
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.  
  516.  
  517.  
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526. X Version 11            Release 6                8
  527.  
  528.  
  529.