home *** CD-ROM | disk | FTP | other *** search
/ Amiga Games 1996 January / amigagames-cdrom-1996-01.iso / userbox / publicdomain / toolmanager / goodies / getpubname.lha / GetPubName / GetPubName.doc < prev    next >
Text File  |  1992-09-26  |  3KB  |  101 lines
  1. GetPubName V1.4 Documentation
  2. =============================
  3. Programm and Documentation © Copyright 1992 by Michael `Mick' Hohmann.
  4.  
  5. IMPORT StdDisclaimer; (* in short: use it at your own risk *)
  6. GetPubName was carefully tested, but there's certainly plenty of room for
  7. bugs.
  8.  
  9. GetPubName V1.4 is Freeware, non-commercial distribution is o.k. as long as
  10. the following conditions are met:
  11.  
  12.   * Source, executable and documentation must be distributed together
  13.     (GetPubName.mod, MoreIntuition.mod, GetPubName, GetPubName.doc and
  14.     GetPubName.dok), and these files must be intact (you're not allowed to
  15.     make changes).
  16.  
  17.   * Disk librarians: you may charge no more than the current price
  18.     of a single AmigaLibDisk from Fred Fish
  19.  
  20.  
  21. GetPubName requires AmigaOS V37 or later (that's 2.04 or later).
  22.  
  23.  
  24. Purpose
  25. =======
  26. GetPubName returns the Name of the frontmost PubScreen either to StdOut,
  27. or if specified to a global/local Environment-Variable.
  28.  
  29. The main usage is supposed to be in conjunction with other programs,
  30. that need a PubScreenName, and the BackTick "`". E.g. I call the C=
  31. Calculator from my ToolManager-Hotkey-DockWindow with:
  32.  
  33.      "Calculator PUBSCREEN=`GetPubName`"
  34.  
  35. The Calculator will open on the frontmost PubScreen, like the
  36. Hotkey-DockWindow itself.
  37.  
  38.  
  39. Usage
  40. =====
  41. GetPubName [ENV | ENVIRONMENT name] [LOC | LOCAL] [HELP]
  42.  
  43. HELP
  44. ----
  45. Displays a short help message.
  46.  
  47. ENV | ENVIRONMENT  name
  48. -----------------------
  49. If you specify a name GetPubName will write the PubScreenName to an
  50. Environment-Variable.
  51.  
  52. LOC | LOCAL
  53. -----------
  54. If you specify this switch together with a name, GetPubName will write
  55. the PubScreenName to a local Environment-Variable.
  56.  
  57.  
  58. Example: GetPubName PubScreenName
  59.          will save the name of the frontmost PubScreen to the global
  60.          Environment-Variable "PubScreenName"
  61.  
  62.  
  63. History
  64. =======
  65. V1.4    Bug-Fix (thanx to `tron') and included the local Env-Vars
  66. V1.3    translated to Oberon
  67. V1.2    now the PubScreenName can be saved to a global Environment-Varibale
  68. V1.1    First usable version :-)
  69. V0.x    some attempts...
  70.  
  71.  
  72. Known problems/bugs
  73. ===================
  74. None so far...
  75.  
  76.  
  77. You can contact me through the Usenet:
  78.  
  79.    swb.de!imart!mickh
  80. or after 1-OCT-92 try
  81.    mickh@imart.franken.de
  82.  
  83. Or through the snail mail:
  84.  
  85.    Michael-W. Hohmann
  86.    Carl-Schilling-Str. 10
  87.    D-8701 Kirchheim
  88.    Germany
  89.  
  90. Thanx
  91. =====
  92. The following people contributed suggestions and bugreports:
  93.  
  94.   Bernhard Möllemann
  95.   Jürgen Weinelt
  96.   Steffen Reith
  97.   Hartmut Goebel
  98.   Matthias `Tron' Scheler
  99.  
  100. Many thanks to each of you.
  101.