home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / World_Of_Computer_Software-02-386-Vol-2of3.iso / b / bricon20.zip / bricons / bricons.txt < prev    next >
Text File  |  1992-07-30  |  8KB  |  265 lines
  1.  
  2.  
  3.  
  4. BRICONS(l)        MISC. REFERENCE MANUAL PAGES         BRICONS(l)
  5.  
  6.  
  7.  
  8. NAME
  9.      bricons - quick start  up  utility  for  applications  using
  10.      text, icons and pop-up menus on an X display
  11.  
  12. SYNOPSIS
  13.      bricons  [options]
  14.      [-file] [-col] [-help] [-sensitive]
  15.      [-bmdir] [-default]
  16.  
  17. DESCRIPTION
  18.      Bricons program allows the user to quickly start up applica-
  19.      tions  by  selecting the appropriate button from the display
  20.      and pressing the left mouse button.  A maximum of up to six-
  21.      teen main menu buttons can be displayed. Each main menu but-
  22.      ton can launch an application or pop-up a sub menu  contain-
  23.      ing more buttons. The buttons can be represented as a bitmap
  24.      or as text.
  25.  
  26.      Information on how the program is  to  present  each  button
  27.      (either  as a bitmap or text) and the application that is to
  28.      be executed if that  button  is  selected  is  contained  in
  29.      script  file  called .briconsrc.  This file should be stored
  30.      in the same directory as the program is executed from.
  31.  
  32.      The .briconsrc file contains a number of key words which are
  33.      used  to indicate if the button label is some text or a bit-
  34.      map and if the button is to pop-up a sub menu  or  launch  a
  35.      program.  These key words are explained below:
  36.  
  37.      The .briconsrc file should start with the keyword  %icon  or
  38.      %text  The key word %icon indicates that the button label is
  39.      a bitmap.  This should be followed by the file name contain-
  40.      ing the bitmap.  For example:
  41.  
  42.                            %icon clock.icon
  43.  
  44.      The key word %text indicates that the button label  is  some
  45.      text.   The  text can be split over three lines by using the
  46.      new line character \n.  For example:
  47.  
  48.                       %text Line1\nLine2\nLine3
  49.  
  50.      would be presented as:
  51.                                 Line1
  52.                                 Line2
  53.                                 Line3
  54.  
  55.      Once a  button  has  been  selected  it  is  prevented  from
  56.      accidentally  being  re-selected by "graying out" the button
  57.      (default action).  Sometimes however it maybe  desirable  to
  58.      allow the button to be selected more than once.  This can be
  59.      done be using the keyword %icon+ or %text+
  60.  
  61.  
  62.  
  63. Sun Release 4.1   Last change: 28th March 1992                  1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. BRICONS(l)        MISC. REFERENCE MANUAL PAGES         BRICONS(l)
  71.  
  72.  
  73.  
  74.      The next line in the .briconsrc file should  either  contain
  75.      the key word %sub_menu or the application to be started.  If
  76.      the name of an application  is given then a check is made to
  77.      see if such an program can be executed.  If the program does
  78.      not exist or is not in the users path then an error  message
  79.      is printed and the button associated with the application is
  80.      ignored.
  81.  
  82.      If the key word %sub_menu is used then a pop-up sub menu  is
  83.      created.   Any further buttons defined in the briconsrc file
  84.      will appear in the sub menu for that button  until  the  key
  85.      word  %end_sub_menu  is found.  A maximum of ten buttons are
  86.      allowed in a single pop-up sub menu.
  87.  
  88.      Any line in the .briconsrc file starting with a #  character
  89.      is treated as a comment and will be ignored.
  90.  
  91.      This program has four default buttons labelled source, edit,
  92.      help  and  quit.   The  edit  button allows the user to edit
  93.      there icon file (default being an empty source button causes
  94.      the  program  to  distory  all  the  current  buttons  being
  95.      displayed and re-read the icon file and display the new but-
  96.      tons.
  97.  
  98. OPTIONS
  99.      bricons accepts all of  the  standard  X   Toolkit   command
  100.      line options along with the additional options listed below:
  101.  
  102.      -file
  103.           Tells the program to read  this  file  instead  of  the
  104.           default file.
  105.  
  106.      -col Indicates the number of  buttons  in  a  column  before
  107.           starting  a  new row.  The default number of columns is
  108.           15.
  109.  
  110.      -help
  111.           Tells the program the path for the help file.
  112.  
  113.      -sensitive
  114.           Toggle used for default "graying out" of selected  but-
  115.           tons.   If  set  to  TRUE  then buttons will "gray out"
  116.           unless specifically requested not to.
  117.  
  118.      -bmdir
  119.           This program will search the default  bitmap  directory
  120.           (./bitmaps)  for  any  bitmaps  that  are to be used to
  121.           represent buttons.  If you wish to add different bitmap
  122.           directories  then  use  this command line argument fol-
  123.           lowed by a colon separated list  of  path  names.   For
  124.           example  if  the  program  needs to find bitmaps in two
  125.           different directories then the following can be entered
  126.  
  127.  
  128.  
  129. Sun Release 4.1   Last change: 28th March 1992                  2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. BRICONS(l)        MISC. REFERENCE MANUAL PAGES         BRICONS(l)
  137.  
  138.  
  139.  
  140.           at the command line:
  141.  
  142.            bricons -bmdir /usr/local/bitmaps:/usr/mydir/bitmaps
  143.  
  144.      -default
  145.           Toggle used for  including/not  including  the  default
  146.           Edit  Icons   button in the bricons program.  This flag
  147.           expects a Boolean value.  If  the  bricons  program  is
  148.           called  with  the  -default  flag set to False then the
  149.           Edit Icons  button is not included.
  150.  
  151.  
  152. X DEFAULTS
  153.      The bricons program reads the .Xdefaults file  and  Xbricons
  154.      resource  file  during  startup  and  uses  the  appropriate
  155.      resource  specification  to  customise  the  appearance   or
  156.      characteristics  of  its  display.  This program understands
  157.      all of the core resource names and classes as well as:
  158.  
  159.      no_of_cols
  160.           Specifies the number of buttons in a column.
  161.  
  162.      icon_file
  163.           Specifies path name for icon file to be read.
  164.  
  165.      help_file
  166.           Specifies path name for help file.
  167.  
  168.      icon_dirs
  169.           Specifies path name for bitmap directories.
  170.  
  171.  
  172. SETTING BITMAP DIRECTORIES
  173.      This section explains how to specify bitmap file paths using
  174.      the  .Xdefaults  file.  For the quickest and simplest method
  175.      see the OPTIONS section under -bmdir.
  176.  
  177.      This program will search the default  bitmap  directory  for
  178.      any bitmaps that are to be used to represent buttons. If the
  179.      user wishes the program to search other directories for bit-
  180.      map  files  then  this  should  be  specified  in  the users
  181.      .X11defaults file.  *BitmapFilePath: should  be  added  fol-
  182.      lowed  by  colon separated path names where the bitmap files
  183.      can be found.  For example:
  184.  
  185.      *BitmapFilePath:    /usr/local/include/X11/bitmaps:/usr/mydir/bitmaps
  186.  
  187. RESOURCE FILES
  188.      The Xbricons file specifies the required resources.  To make
  189.      sure  the  program uses the resources file set the following
  190.      line in your .login:
  191.             setenv  XUSERFILESEARCHPATH ~/app_defaults/%N
  192.  
  193.  
  194.  
  195. Sun Release 4.1   Last change: 28th March 1992                  3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. BRICONS(l)        MISC. REFERENCE MANUAL PAGES         BRICONS(l)
  203.  
  204.  
  205.  
  206.      and place all all resources in the app_defaults directory.
  207.  
  208. WIDGETS
  209.      The bricons program is  a  toolkit-based  application  which
  210.      consists  of  a combination of widgets.  In order to specify
  211.      resources, it is useful to know the hierarchy of the widgets
  212.      which compose bricons.  In the list below, indentation indi-
  213.      cates hierarchical structure.   The  widget  class  name  is
  214.      given first, followed by the widget instance name.
  215.  
  216.           Xbricons  toplevel
  217.                Form box
  218.                     Command   action[18]
  219.                     OverrideShell  popup_shell
  220.                          Form popup_layout
  221.                          Command   sub_action[10]
  222.  
  223. EXAMPLE
  224.      Below is an example of a simple .briconsrc file:
  225.  
  226.      # <-- a line starting with a '#' is a comment line
  227.      #
  228.      #       Bri's icon file
  229.      #
  230.  
  231.      # first line must have keyword %icon or %text
  232.      # to indicate if button is an icon
  233.  
  234.      %icon calculator
  235.      xcalc
  236.      %text Games\n sub\n menu
  237.      %sub_menu
  238.           %text xeyes
  239.           xeyes
  240.           %text othello
  241.           othello
  242.      %end_sub_menu
  243.  
  244.  
  245.  
  246. BUGS
  247.      After selecting the source button the  buttons  may  not  be
  248.      re-displayed  correctly.   Selecting  the  source  button  a
  249.      second time may help.
  250.  
  251. AUTHOR
  252.      Bruce R Ingram, University of Kent at Canterbury.
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261. Sun Release 4.1   Last change: 28th March 1992                  4
  262.  
  263.  
  264.  
  265.