home *** CD-ROM | disk | FTP | other *** search
/ Amiga Elysian Archive / AmigaElysianArchive.iso / screen / psx.lha / PSX.docs < prev    next >
Text File  |  1990-12-08  |  6KB  |  159 lines
  1.  
  2.  
  3.                   PSX (PublicScreenX)
  4.             
  5.                           A 2.0 Public Screen Manager
  6.  
  7.                    by Steve Tibbett
  8.  
  9.  
  10.  
  11. PSX is a utility that won't mean much to you unless you have programs that
  12. use public screens, or you need to have a public screen around to open
  13. windows on.
  14.  
  15. PSX can be run with no arguments, in which case it will open up it's
  16. user interface, or you can get it to do most of it's things from the
  17. command line.
  18.  
  19. THE USER INTERFACE
  20.  
  21. The user interface is very straightforward so I will only touch on it
  22. lightly here.  
  23.  
  24. When you run PSX with no arguments, a window will open with gadgets along
  25. the left side, and a scrolling list on the right side.  The scrolling list
  26. contains the names of all the public screens currently in the system, and
  27. the gadgets on the left are various ways of maniuplating items in the list.
  28.  
  29. To select a screen, simply click on it's name.  The name of the last 
  30. selected screen is just below the list.  
  31.  
  32. "Open Screen" will pop up another window with screen selection gadgets -
  33. type in the name you want for your new screen, if you want it to be
  34. hires, etc., click on the appropriate gadgets, then click Open Screen
  35. (or Cancel if you get cold feet).
  36.  
  37. "Close Screen" will attempt to close the screen.  Public Screens are 
  38. supposed to be closed by the program that owns them, so this is usually
  39. only a good idea to perform on screens you have opened with "Open Screen".
  40.  
  41. "Move To Screen" will move the PSX window itself to the selected
  42. screen.  If the screen is LORES, PSX may have a hard time squeezing
  43. itself onto the screen, but otherwise it should have no trouble dealing
  44. with whatever fonts and colours the screen has up.
  45.  
  46. "Make Default" will make the selected screen the "Default Public Screen" -
  47. which simply means that any program smart enough to open on the 
  48. "Default Public Screen" will now open on that ascreen.
  49.  
  50. "Refresh List" just grabs a new copy of the screen list, since it won't
  51. automatically notice if a screen appears or disappears while the
  52. window is open.
  53.  
  54. The next two gadgets are "Global Flags" that affect the operation of all
  55. public screens.  The "Shanghai" flag, when on, will redirect all windows that
  56. would have gone to the "Workbench" screen to the "Default Public Screen",
  57. and the "PopPubScreen" flag will bring to the front any public screen as
  58. a window opens on it.
  59.  
  60. THE COMMAND LINE
  61.  
  62. Typing "PSX ?" will give you this:
  63.  
  64. OPEN/K,CLOSE/K,HIRES/S,LACE/S,DEPTH/N,MAKEDEFAULT/S,SHANGHAI/S,
  65. NOSHANGHAI/S,POP/S,NOPOP/S,TOFRONT/K,TOBACK/K
  66.  
  67. and in that line is everything you need to know about PSX's command line
  68. interface. The keywords are:
  69.     
  70.     OPEN "ScreenName"
  71.     CLOSE "ScreenName"
  72.     SHANGHAI
  73.     NOSHANGHAI
  74.     POP
  75.     NOPOP
  76.     TOFRONT "ScreenName"
  77.     TOBACK "ScreenName"
  78.  
  79. The HIRES and DEPTH items are flags for the OPEN command (ie, 
  80. OPEN "ScreenName" HIRES LACE will open a hires interlaced screen.  The
  81. depth is specified as DEPTH 3 where 3 is the number of bitplanes the
  82. screen is to have.  MAKEDEFAULT specifies that the newly opened screen
  83. should also become the Default Public Screen.
  84.  
  85. SHANGHAI and NOSHANGHAI turn the Shanghai flag on and off.  These get
  86. processed AFTER the "Open" and "Close" commands.
  87.  
  88. POP and NOPOP turn on and off the POPPUBSCREEN flag - enable and disable
  89. the popping to the front of any screen whenever a window is opened.
  90.  
  91. So a valid command line would be:
  92.  
  93.       PSX OPEN "CLIScreen" HIRES LACE DEPTH 1 MAKEDEFAULT SHANGHAI POP
  94.  
  95. which would give you a screen entitled "CLIScreen", Hires interlaced,
  96. (with the actual dimensions taken from your preferences), and the SHANGHAI
  97. and POPPUBSCREEN flags are both turned on.
  98.  
  99. This in combination with the fact that under 2.0 you can give a Public
  100. Screen name for console windows to open up on means you can set up a 
  101. screen for the exclusive purpose of running a CLI or two on, making them
  102. one bitplane so they scroll more quickly than the Workbench screen,
  103. which would look kind of ugly in one bitplane.
  104.  
  105. Remember that all public screen names ARE case sensitive - "MyScreen" is 
  106. not the same as "MYSCREEN".
  107.  
  108. THE SOURCE
  109.  
  110. I've included the source to PSX.  It's a very "2.0" program - it uses
  111. the DOS "ReadArgs" call to parse the command line, it uses GadTools for
  112. the user interface, and (I believe) is a good example for dealing with
  113. public screens.
  114.  
  115. It compiles with the Lattice 5.10 C compiler and the 2.0 includes.  It
  116. will probably only compile with Lattice, as I've taken a liking to the 
  117. C++ comment style, which Lattice permits.
  118.  
  119.  
  120. AUTHOR AND DISTRIBUTION INFORMATION
  121.  
  122. PSX is freely redistributable, but is also Copyright 1990 Steve Tibbett.
  123. Distribution is only very slightly limited:  You may not distribute 
  124. PSX without it's current documentation, nor without source, 
  125. and if it is to be commercially distributed, I won't demand but I would
  126. appreciate being sent a copy of whatever it is being distributed with
  127. or on (in the case of disk magazines).
  128.  
  129. Like all my stuff, PSX will likely continue to change.  If you like
  130. PSX, check with wherever you got it every few months for updated
  131. versions, especially if you have problems with it (and have let me
  132. know about them), as I normally fix problems quickly.
  133.  
  134. I don't ask for any cash contribution for PSX.  If you are feeling
  135. guilty and just want to send something, send an original game or
  136. a neat demo, I'll probably appreciate it more than cash.
  137.  
  138.  
  139. My Virutal Addresses:
  140.  
  141.     My BBS is 613-731-3419, up 24 hours/day running my own BBS (BBX)...
  142.     You can reach me on Plink (where I'm an Asst. Chair) as STEVEX...
  143.     You can reach me on Bix as "s.tibbett"...
  144.     You can reach me through FidoNet on point 1:163/109.42...
  145.     You can send me Usenet mail at cognos!alzabo!omx!stevex...
  146.     Or you can call me at 613-731-5316.
  147.  
  148.     I prefer talking with people electronically (including phone) rather
  149.     than mail - I answer all email, but very little paper mail.
  150.  
  151.  
  152. My Physical Address:
  153.  
  154.     Steve Tibbett
  155.     2710 Saratoga Pl. #1108
  156.     Gloucester, Ontario
  157.     K1T 1Z2 Canada
  158.  
  159.