


XMAN(1)                                                   XMAN(1)


NNAAMMEE
       xman  -  Manual page display program for the X Window Sys-
       tem.

SSYYNNOOPPSSIISS
       xxmmaann [-options ...]

DDEESSCCRRIIPPTTIIOONN
       _X_m_a_n is a manual page browser.  The default  size  of  the
       initial _x_m_a_n window is small so that you can leave it run-
       ning throughout your entire login session.  In the initial
       window  there are three options: _H_e_l_p will pop up a window
       with on-line help, _Q_u_i_t will exit, and  _M_a_n_u_a_l  _P_a_g_e  will
       pop up a window with a manual page browser in it.  You may
       pop up more than one manual page  browser  window  from  a
       single execution of _x_m_a_n.

       For  further information on using _x_m_a_n please read the on-
       line help information.  The rest of this manual page  will
       discuss customization of _x_m_a_n.


CCUUSSTTOOMMIIZZIINNGG XXMMAANN
       _X_m_a_n  allows  customization  of both the directories to be
       searched for manual pages, and the name that  each  direc-
       tory  will  map  to in the _S_e_c_t_i_o_n_s menu.  Xman determines
       which directories it will search by  reading  the  _M_A_N_P_A_T_H
       environment  variable.   If  no  _M_A_N_P_A_T_H is found then the
       directory is /usr/man is searched on POSIX systems.   This
       environment  is  expected  to be a colon-separated list of
       directories for xman to search.

       setenv MANPATH /mit/kit/man:/usr/man

       By default, _x_m_a_n will search each of the following  direc-
       tories  (in each of the directories specified in the users
       MANPATH) for manual pages.  If manual pages exist in  that
       directory  then they are added to list of manual pages for
       the corresponding menu item.  A menu  item  is  only  dis-
       played  for  those  sections  that actually contain manual
       pages.

       Directory      Section Name
       ---------      ------------
       man1           (1) User Commands
       man2           (2) System Calls
       man3           (3) Subroutines
       man4           (4) Devices
       man5           (5) File Formats
       man6           (6) Games
       man7           (7) Miscellaneous
       man8           (8) Sys. Administration
       manl           (l) Local
       mann           (n) New



X Version 11 Release 4      Release 4                           1





XMAN(1)                                                   XMAN(1)


       mano           (o) Old

       For instance, a user has three directories in  her  manual
       path  and each contain a directory called _m_a_n_3.  All these
       manual pages will appear alphabetically  sorted  when  the
       user  selects  the  menu  item called _(_3_) _S_u_b_r_o_u_t_i_n_e_s.  If
       there is no directory called _m_a_n_o in any of  the  directo-
       ries  in  her MANPATH, or there are no manual pages in any
       of the directories called _m_a_n_o then no menu item  will  be
       displayed for the section called _(_o_) _O_l_d.


       By using the _m_a_n_d_e_s_c file a user or system manager is able
       to more closely control which manual pages will appear  in
       each of the sections represented by menu items in the _S_e_c_-
       _t_i_o_n_s menu.  This functionality is  only  available  on  a
       section  by section basis, and individual manual pages may
       not be handled in this manner (Although  generous  use  of
       symbolic  links - ln(1) - will allow almost any configura-
       tion you can imagine).

       The format of the mandesc file is a character followed  by
       a  label.   The character determines which of the sections
       will be added under this label.  For instance suppose that
       you  would like to create an extra menu item that contains
       all programmer subroutines.  This label should contain all
       manual  pages in both sections two and three.  The _m_a_n_d_e_s_c
       file would look like this:

       2Programmer Subroutines
       3Programmer Subroutines

       This will add a menu item to the _S_e_c_t_i_o_n_s menu that  would
       bring up a listing of all manual pages in sections two and
       three of the Programmers Manual.  Since  the  label  names
       are  _e_x_a_c_t_l_y  the same they will be added to the same sec-
       tion. Note, however,  that  the  original  sections  still
       exist.

       If you want to completely ignore the default sections in a
       manual directory then add the line:

       no default sections

       anywhere in your  mandesc  file.   This  keeps  xman  from
       searching  the  default  manual sections _I_n _t_h_a_t _d_i_r_e_c_t_o_r_y
       _o_n_l_y.  As an example, suppose you  want  to  do  the  same
       thing  as  above, but you don't think that it is useful to
       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.
       You  would  need to duplicate the default entries, as well
       as adding your new one.

       no default sections
       1(1) User Commands



X Version 11 Release 4      Release 4                           2





XMAN(1)                                                   XMAN(1)


       2Programmer Subroutines
       3Programmer Subroutines
       4(4) Devices
       5(5) File Formats
       6(6) Games
       7(7) Miscellaneous
       8(8) Sys. Administration
       l(l) Local
       n(n) New
       o(o) Old

       Xman  will  read  any  section  that  is   of   the   from
       _m_a_n_<_c_h_a_r_a_c_t_e_r_>,  where  <character>  is  an upper or lower
       case letter (they are treated  distinctly)  or  a  numeral
       (0-9).  Be warned, however, that man(1) and catman(8) will
       not search directories that are non-standard.


CCOOMMMMAANNDD LLIINNEE OOPPTTIIOONNSS
       Xman supports all standard Toolkit command line  arguments
       (see  _X_(_1_)).   The following additional arguments are sup-
       ported.


       --hheellppffiillee _f_i_l_e_n_a_m_e
              Specifies a helpfile to use other than the default.

       --bbootthhsshhoowwnn
              Allows both the manual page and manual directory to
              be on the screen at the same time.

       --nnoottooppbbooxx
              Starts without the Top Menu with the three  buttons
              in it.

       --ggeeoommeettrryy _W_x_H_+_X_+_Y
              Sets the size and location of the Top Menu with the
              three buttons in it.

       --ppaaggeessiizzee _W_x_H_+_X_+_Y
              Sets the size and location of all the Manual Pages.


WWIIDDGGEETTSS
       In  order  to  specify resources, it is useful to know the
       hierarchy of the widgets which compose _x_m_a_n.  In the nota-
       tion  below, indentation indicates hierarchical structure.
       The widget class name is given first, followed by the wid-
       get instance name.

       Xman xman _(_T_h_i_s _w_i_d_g_e_t _i_s _n_e_v_e_r _u_s_e_d_)
            TopLevelShell  topbox
                 Form  form
                      Label  topLabel



X Version 11 Release 4      Release 4                           3





XMAN(1)                                                   XMAN(1)


                      Command  helpButton
                      Command  quitButton
                      Command  manpageButton
                 TransientShell  search
                      DialogWidgetClass  dialog
                           Label  label
                           Text  value
                           Command  manualPage
                           Command  apropos
                           Command  cancel
                 TransientShell  pleaseStandBy
                      Label  label
            TopLevelShell  manualBrowser
                 Paned  Manpage_Vpane
                      Paned  horizPane
                           MenuButton  options
                           MenuButton  sections
                           Label  manualBrowser
                      Viewport  directory
                           List  directory
                           List  directory
                           .
                           . (one for each section,
                           .  created "on the fly")
                           .
                      ScrollByLine  manualPage
                 SimpleMenu  optionMenu
                      SmeBSB  displayDirectory
                      SmeBSB  displayManualPage
                      SmeBSB  help
                      SmeBSB  search
                      SmeBSB  showBothScreens
                      SmeBSB  removeThisManpage
                      SmeBSB  openNewManpage
                      SmeBSB  showVersion
                      SmeBSB  quit
                 SimpleMenu  sectionMenu
                      SmeBSB  <name of section>
                           .
                           . (one for each section)
                           .
                 TransientShell  search
                      DialogWidgetClass  dialog
                           Label  label
                           Text  value
                           Command  manualPage
                           Command  apropos
                           Command  cancel
                 TransientShell  pleaseStandBy
                      Label  label
                 TransientShell  likeToSave
                      Dialog  dialog
                           Label  label
                           Text  value



X Version 11 Release 4      Release 4                           4





XMAN(1)                                                   XMAN(1)


                           Command  yes
                           Command  no
            TopLevelShell  help
                 Paned  Manpage_Vpane
                      Paned  horizPane
                           MenuButton  options
                           MenuButton  sections
                           Label  manualBrowser
                      ScrollByLine  manualPage
                 SimpleMenu  optionMenu
                      SmeBSB  displayDirectory
                      SmeBSB  displayManualPage
                      SmeBSB  help
                      SmeBSB  search
                      SmeBSB  showBothScreens
                      SmeBSB  removeThisManpage
                      SmeBSB  openNewManpage
                      SmeBSB  showVersion
                      SmeBSB  quit


AAPPPPLLIICCAATTIIOONN RREESSOOUURRCCEESS
       _x_m_a_n  has  the  following  application-specific  resources
       which allow customizations unique to _x_m_a_n.


       mmaannuuaallFFoonnttNNoorrmmaall (Class FFoonntt)
                         The font to use for normal text  in  the
                         manual pages.

       mmaannuuaallFFoonnttBBoolldd (Class FFoonntt)
                         The  font  to  use  for bold text in the
                         manual pages.

       mmaannuuaallFFoonnttIIttaalliicc (Class FFoonntt)
                         The font to use for italic text  in  the
                         manual pages.

       ddiirreeccttoorryyFFoonnttNNoorrmmaall (Class FFoonntt)
                         The  font to use for the directory text.

       bbootthhSShhoowwnn (Class BBoooolleeaann)
                         Either  'true'  or  'false',   specifies
                         whether  or not you want both the direc-
                         tory and the manual page shown at  start
                         up.

       ddiirreeccttoorryyHHeeiigghhtt (Class DDiirreeccttoorryyHHeeiigghhtt)
                         The  height  in pixels of the directory,
                         when the directory and the  manual  page
                         are shown simultaneously.

       ttooppCCuurrssoorr (Class CCuurrssoorr)
                         The cursor to use in the top box.



X Version 11 Release 4      Release 4                           5





XMAN(1)                                                   XMAN(1)


       hheellppCCuurrssoorr (Class CCuurrssoorr)
                         The cursor to use in the help window.

       mmaannppaaggeeCCuurrssoorr (Class CCuurrssoorr)
                         The  cursor  to  use  in the manual page
                         window.

       sseeaarrcchhEEnnttrryyCCuurrssoorr (Class CCuurrssoorr)
                         The cursor to use in  the  search  entry
                         text widget.

       ppooiinntteerrCCoolloorr (Class FFoorreeggrroouunndd)
                         This  is  the  color  of all the cursors
                         (pointers) specified  above.   The  name
                         was  chosen to be compatible with xterm.

       hheellppFFiillee  (Class FFiillee)
                         Use this rather than the system  default
                         helpfile.

       ttooppBBooxx (Class BBoooolleeaann)
                         Either  'true'  or  'false',  determines
                         whether  the  top  box  (containing  the
                         help, quit and manual page buttons) or a
                         manual page is  put  on  the  screen  at
                         start-up.  The default is true.

       vveerrttiiccaallLLiisstt (Class BBoooolleeaann)
                         Either  'true'  or  'false',  determines
                         whether the directory listing is  verti-
                         cally  or  horizontally  organized.  The
                         default is horizontal (false).


GGLLOOBBAALL AACCTTIIOONNSS
       _X_m_a_n defines all user interaction through global  actions.
       This  allows  the  user to modify the translation table of
       any widget, and bind any event to  the  new  user  action.
       The list of actions supported by _x_m_a_n are:

       GGoottooPPaaggee((_p_a_g_e)) When  used  in a manual page display window
                      this will allow the user to move between  a
                      directory  and  manual  page  display.  The
                      _p_a_g_e argument can be  either  DDiirreeccttoorryy  or
                      MMaannuuaallPPaaggee.

       QQuuiitt(())         This  action may be used anywhere, and will
                      exit xman.

       SSeeaarrcchh((_t_y_p_e,, _a_c_t_i_o_n))
                      Only useful when used in  a  search  popup,
                      this action will cause the search widget to
                      perform the named search type on the string
                      in  the  search  popup's value widget. This



X Version 11 Release 4      Release 4                           6





XMAN(1)                                                   XMAN(1)


                      action will also pop down the  search  wid-
                      get.  The _t_y_p_e argument can be either AApprroo--
                      ppooss, MMaannppaaggee or CCaanncceell.  If  an  _a_c_t_i_o_n  of
                      OOppeenn is specified then xman will open a new
                      manual page to display the results  of  the
                      search, otherwise xman will attempt to dis-
                      play the  results  in  the  parent  of  the
                      search popup.

       PPooppuuppHHeellpp(())    This  action may be used anywhere, and will
                      popup the help widget.

       PPooppuuppSSeeaarrcchh(())  This action may be used anywhere except  in
                      a  help  window.   It will cause the search
                      popup to become active and visible  on  the
                      screen, allowing the user search for a man-
                      ual page.

       CCrreeaatteeNNeewwMMaannppaaggee(())
                      This action may be used anywhere, and  will
                      create a new manual page display window.

       RReemmoovveeTThhiissMMaannppaaggee(())
                      This  action may be used in any manual page
                      or help display  window.   When  called  it
                      will  remove  the  window, and clean up all
                      resources associated with it.

       SSaavveeFFoorrmmaatttteeddPPaaggee((_a_c_t_i_o_n))
                      This action can only be used in the  "like-
                      ToSave"   popup   widget,  and  tells  xman
                      whether to SSaavvee or CCaanncceell  a  save  of  the
                      manual page that has just been formatted.

       SShhoowwVVeerrssiioonn(())  This  action  may be called from any manual
                      page or help display window, and will cause
                      the  informational display line to show the
                      current version of xman.

FFIILLEESS
       _<_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>

       _<_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>

       _<_m_a_n_p_a_t_h _d_i_r_e_c_t_o_r_y_>/mandesc

       /usr/lib/X11/app-defaults/Xman
                                specifies required resources

       /tmp                     _X_m_a_n creates temporary  files  in
                                /tmp   for  all  unformatted  man
                                pages and all apropos searches.





X Version 11 Release 4      Release 4                           7





XMAN(1)                                                   XMAN(1)


SSEEEE AALLSSOO
       X(1), X(8C), man(1), apropos(1), catman(8), Athena  Widget
       Set


EENNVVIIRROONNMMEENNTT
       DDIISSPPLLAAYY        the default host and display to use.

       MMAANNPPAATTHH        the search path for manual pages.  Directo-
                      ries  are   separated   by   colons   (e.g.
                      /usr/man:/mit/kit/man:/foo/bar/man).

       XXEENNVVIIRROONNMMEENNTT   to  get  the  name  of a resource file that
                      overrides the global  resources  stored  in
                      the RESOURCE_MANAGER property.

       XXAAPPPPLLRREESSDDIIRR    A  string that will have "Xman" appended to
                      it.  This string will be the full path name
                      of  a  user  app-defaults file to be merged
                      into the resource database after the system
                      app-defaults file, and before the resources
                      that are attached to the display.


BBUUGGSS
       There probably are some.

CCOOPPYYRRIIGGHHTT
       Copyright 1988 by Massachusetts Institute of Technology.
       See _X_(_1_) for a full statement of rights and permissions.

AAUUTTHHOORRSS
       Chris Peterson, MIT X  Consortium  from  the  V10  version
       written by Barry Shein formerly of Boston University.























X Version 11 Release 4      Release 4                           8


