home *** CD-ROM | disk | FTP | other *** search
/ World of A1200 / World_Of_A1200.iso / programs / text / jed / doc / pubman.doc < prev    next >
Text File  |  1995-02-27  |  3KB  |  108 lines
  1.  
  2. PUBMAN.DOC
  3. ==========
  4.  
  5. pubman is a tool for manipulating public screens, it allows you to open new
  6. screens and to define which screen Workbench windows will open on, amongst
  7. other things.
  8.  
  9. usage: (CLI only)
  10.     pubman {<command>}
  11.  
  12. where <command> is,
  13.  
  14.     li
  15.     - list the names of all currently open public screens.
  16.  
  17.     dp[name]
  18.     - set the default public screen. (This is the screen which JEd's windows
  19.       will open on.) If no name is given the name of the current default
  20.       screen is echoed back.
  21.  
  22.     md[s+|s-|p+|p-]
  23.     - set the status of either of the available global public screen modes,
  24.       they have the following meanings,
  25.  
  26.     s+  -- shanghai on
  27.     s-  -- shanghai off
  28.     p+  -- poppub on
  29.     p-  -- poppub off
  30.  
  31.     shanghai    - workbench windows will be opened on the default public
  32.               screen
  33.     poppub        - when a visitor window is opened, the public screen it
  34.               opens on is brought to the front of the display.
  35.  
  36.       If no argument is given the current modes (in hex) will be displayed
  37.  
  38.     di[displayID]
  39.     - define the type of all subsequent screens opened by pubman, some of the
  40.       available 'displayID's are,
  41.  
  42.     LORES        --  0x00000000
  43.     HIRES        --  0x00008000
  44.     SUPER        --  0x00008020
  45.     HAM        --  0x00000800
  46.     LORESLACE    --  0x00000004
  47.     HIRESLACE    --  0x00008004
  48.     SUPERLACE    --  0x00008024
  49.     HAMLACE        --  0x00000804
  50.  
  51.       these all use the default monitor but they may be OR'ed with the
  52.       following,
  53.  
  54.     NTSC_MONITOR    --  0x00011000
  55.     PAL_MONITOR    --  0x00021000
  56.     VGA_MONITOR    --  0x00031000        ; These two work slightly
  57.     A2024_MONITOR    --  0x00041000        ; differently, see the includes
  58.  
  59.       the defined value is given as the SA_DisplayID tag for the screen,
  60.       other values are defined in the include file, graphics/displayinfo.h
  61.  
  62.       the default value is 0x8000 (a hires screen on the default monitor).
  63.  
  64.       If no argument is given the current setting will be displayed (in
  65.       hexadecimal)
  66.  
  67.     de[planes]
  68.     - defines the number of bitplanes that opened screens will have, the
  69.       relationship between the number of bitplanes and the number of
  70.       available colours is,
  71.     bpls,        cols,
  72.     1        2
  73.     2        4
  74.     3        8
  75.     4        16
  76.     ...        ...
  77.     n        2^n
  78.  
  79.       the default is 2 bitplanes.
  80.       If no planes argument is given the current value is echoed.
  81.  
  82.     si[width/height]
  83.     - defines the size of all subsequently `op'ened screens, if the values
  84.       are larger than the text overscan area the screen will autoscroll.
  85.       If no arguments are given the current values will be displayed.
  86.  
  87.     op<name>
  88.     - attempts to open a public screen of name <name>. The dispID and depth
  89.       values will be used to define the characteristics of the screen.
  90.  
  91.     cl<name>
  92.     - closes the public screen <name>, only screens opened with the open
  93.       command may be closed. There must be no visitor windows open on the
  94.       screen before it is allowed to close.
  95.  
  96.  
  97. examples:
  98.     To redirect new Workbench windows to an alternative screen,
  99.     1> pubman opNewScreen dpNewScreen mds+
  100.  
  101.     To run a program which opens its windows on the default public screen
  102.     (ie, JEd) in its own screen, (from a script)
  103.     if pubman opScreen dpScreen
  104.     program-name
  105.     pubman clScreen
  106.     endif
  107.  
  108.