home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 3 Comm / 03-Comm.zip / gopgp120.zip / GOPGP.DOC < prev    next >
Text File  |  1998-10-05  |  19KB  |  375 lines

  1.  
  2.                ██████╗   ██████╗    ██████╗   ██████╗  ██████╗
  3.               ██╔════╝  ██╔═══██╗   ██╔══██╗ ██╔════╝  ██╔══██╗
  4.               ██║  ███╗ ██║   ██║   ██████╔╝ ██║  ███╗ ██████╔╝
  5.               ██║   ██║ ██║   ██║   ██╔═══╝  ██║   ██║ ██╔═══╝
  6.               ╚██████╔╝ ╚██████╔╝   ██║      ╚██████╔╝ ██║
  7.                ╚═════╝   ╚═════╝    ╚═╝       ╚═════╝  ╚═╝
  8.                                 Version 1.20
  9.                                 `'`'`'`'`'`'
  10. What is it?
  11. ~~~~~~~~~~~
  12.     GOPGP is a PGP Front-End (And, optionally, a full-featured tagline manager)
  13. for DOS or OS/2 that makes using PGP with your off-line mail reader a LOT
  14. easier! I wrote this because I couldn't find any PGP Front- ends for OS/2, and
  15. I wanted some specific features and ease of use that other similar programs
  16. didn't have, I made it freeware because PGP itself is freeware, and I don't
  17. think it would be right to make money from someone else's work. All I ask in
  18. the way of "registrations" is for you to send me over an E-Mail message telling
  19. me you're using the program, just so I know that all this work wasn't in vain.
  20.  
  21. Legal Stuff:
  22. ~~~~~~~~~~~~
  23.     The author assumes no liability for damages resulting from the use of this
  24. software, even if the damage results from defects in this software, and makes no
  25. representations concerning the merchantability of this software or its
  26. suitability for any specific purpose.  It is provided "as is" without express or
  27. implied warranty of any kind.  Because certain actions may delete files or
  28. render them unrecoverable, the author assumes no responsibility for the loss or
  29. modification of any data.
  30.  
  31. "PGP", "Pretty Good Privacy", "Phil's Pretty Good Software", and the "Pretty
  32. Good" label for computer software and hardware products are all trademarks of
  33. Philip R. Zimmermann.
  34.  
  35. PGP is (c) Copyright Philip R. Zimmermann, 1990-1994.  All rights reserved.  The
  36. PGP User's Guide is also copyright Philip Zimmermann, 1990-1994.  All rights
  37. reserved.  These rights include but are not limited to any foreign language
  38. translations of the manual or the software, and all derivative works of both.
  39.  
  40. System Requirements:
  41. ~~~~~~~~~~~~~~~~~~~~
  42. DOS Version (GOPGP.EXE) - It runs great here under DOS on a 386-SX with
  43.                           4 megs of RAM, so it should run on almost anything.
  44.  
  45. OS/2 Version (GOPGP2.EXE) - Warp 3 or higher. If you can run Warp 3 you
  46.                             shouldn't have any problems.
  47.                             (If you would like a 16-bit version, E-Mail me
  48.                             and I'll see what I can do)
  49.  
  50. Win32 Version (GOPGPW.EXE) - Windows'95/98/NT. If your system can run Windows,
  51.                              you shouldn't have any problems running GOPGP.
  52.  
  53. How To Use It:
  54. ~~~~~~~~~~~~~~
  55.     Simple! Couldn't be easier! Just unzip to any directory (Since you're
  56. reading this, I'll assume to already did that, so I won't bore you by explaining
  57. HOW to unzip a file).
  58.  
  59. IMPORTANT!
  60. If you are upgrading from version 1.00, you *MUST* delete your old GOPGP.CFG, as
  61. the format of the config file has changed, configuration is now internal instead
  62. of a text file.
  63.  
  64. Next, call it from your mail reader and you will be prompted to create a new
  65. config file. Here is an explanation of all of the config options:
  66.  
  67. Your Username (The name used in your PGP key):
  68.   This will be used in the PGP command-lines to specify the name you use to
  69.   decrypt/sign/etc..
  70.  
  71. Path to where PGP is stored:
  72.   This is the path to your PGP Directory, You only need the path (NOT The
  73.   filename!) For example "D:\MY\STUFF\PGP\" (Without the quotes).
  74.  
  75. The Path And Name Of Your External Editor:
  76.   This can be any program that edits text-files (Like you didn't know that
  77.   already! :> ) Just enter the path/name of your editor of choice (NOTE! OS/2
  78.   users should refer to the "Restrictions" section) "@F" will be replaced with
  79.   the message filename. For example: "C:\UTIL\EDITOR.EXE @F /F"
  80.  
  81. Path/Filename Of Default Signature File:
  82.   This file (Text) will be inserted into the bottom of every message you write.
  83.   If you press ENTER at this prompt, signature support will be disabled.
  84.  
  85. Append PID, TEAR, BOTH, or NONE To Messages?:
  86.   Just like it says, if you set this to PID, a PID line will be added to the top
  87.   of your message, if set to TEAR, a tearline will be appended to the end of
  88.   your messages, if you set this to BOTH, both will be added, and if you set
  89.   this to NONE, neither will be added.
  90.  
  91. Path/Name Of External File Viewer:
  92.   (IE: C:\DOS\VIEW.COM @F) Put the name and command-line switches to load your
  93.   external viewer, "@F" will be replaced with the message filename. If you press
  94.   ENTER on this line, the internal file viewer will be used instead.
  95.  
  96. Auto-Detect/Decrypt Encrypted Messages? (Y/n):
  97.   If you set this option to Yes, GOPGP will automatically detect whether or not
  98.   the message is encrypted. If it is encrypted, you will be prompted to
  99.   automagically decrypt it, Yes or No. (Note: When automatically decrypting
  100.   messages, you do not need to first remove quote chars ("SH> " for example)
  101.   from the beginning of each line, as GOPGP does this automatically)
  102.  
  103. Path/Filename Of Your Tagline File:
  104.   If you wish to add taglines to the end of your message, define the
  105.   path/filename of an ASCII text file which contains single-line, 75 character
  106.   or less "taglines". If you press ENTER on this line, Tagline support will be
  107.   disabled.
  108.  
  109. Path/Name Of Your After Edit Utility:
  110.   This is the command-line and parameters of a utility to be executed after you
  111.   edit each message. This could be a spell-checker, an external tagline manager,
  112.   etc.. (IE: C:\SS\SS.EXE @F) Put the name and command-line switches to load
  113.   your external utility, "@F" will be replaced with the message filename.
  114.   Pressing ENTER on this line will disable this feature.
  115.  
  116. Path Where Your Tagfile/Signature Files Are Stored:
  117.   This is the directory where you store your tagline files and signature files.
  118.   This is necessary for when you select "Change Tagfile" or "Change Signature"
  119.   from the tagline selection menu. Tagline files must be named *.TAG and
  120.   signature files must be named *.SIG. If you press ENTER on this line, when
  121.   changing tag/sig files you will simply be prompted to enter a filename.
  122.  
  123. Spell Checker:
  124.   Unlike the afteredit utility (Which is run after editing every message) the
  125.   spell checker is only run when you ask it to. As with all other external
  126.   utilities, @F will be replaced with the message filename. Pressing ENTER on
  127.   this line disables this feature.
  128.  
  129. Command-Line:
  130. ~~~~~~~~~~~~~
  131. Usage: GOPGP(2/W).EXE <name of message file> [switch]
  132.  
  133. <name of message file> = Mandatory
  134. [switch] = Optional
  135.  
  136. Switches:
  137.  
  138. /E - Jump Into Message Editor First
  139. /S - Sign Message And Exit
  140. /D - Decrypt Message And Exit
  141. /A - Encrypt & Sign Message And Exit
  142. /N - Encrypt Message And Exit
  143. /C<filename> - Use <filename> As Config File
  144.  
  145. Use with Bluewave Off-Line Mail Reader:
  146. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  147.     I'm not sure about other versions of Bluewave, but I run Bluewave 2.30/DOS
  148. and it runs great here. To set it up is simplicity in itself. You have to have
  149. some kind of "Swapping" enabled (XMS/EMS/DISK) to free up enough memory for PGP,
  150. your editor, etc.. (Check the Global/Memory Swapping Options/Swap for Msg Editor
  151. and be sure it's set to "Yes"). Then go to the "External" menu and change the
  152. "Message Editor Cmd" to "D:\PATH\TO\GOPGP\GOPGP(2/W).EXE @F" along with any
  153. other command-line switches you would like to use. I recommend using the "/E"
  154. switch, so you don't have to look at my menus every time you edit the message.
  155. That command line would look something like this;
  156. "D:\PATH\TO\GOPGP\GOPGP(2/W).EXE @F /E". If you are using Gopgp's tagline
  157. support, you'll want to go to Preferences/Default Preferences/Tagline Behavior
  158. and set "Tagline Selection Type" to "No Tags". Also, if you're using GOPGP's
  159. internal signature support, you'll want to go to Preferences/Default
  160. Preferences/File And String Preferences and erase the "Signature File Name"
  161. field (So that it's left blank). Just so that you don't end up with two
  162. signatures/taglines on your messages.
  163.  
  164. Use with MsgEd:
  165. ~~~~~~~~~~~~~~~
  166.     For use with the MsgEd Sysop Mail Reader, you *MUST* have ATLEAST version
  167. 4.20 for GOPGP to work correctly, as earlier versions didn't swap out of
  168. memory properly so PGP didn't have enough memory to function, resulting in
  169. horrid problems I won't go into here. The OS/2 and Win32 versions of MsgEd
  170. shouldn't have this problem, and I know that MsgEd/2 TE 04 and 05 work properly.
  171. The set-up for MsgEd is even more simple than Bluewave's set-up, just add the
  172. following line to your MSGED.CFG file:
  173.  
  174. Editor GOPGP.EXE /E
  175.  
  176. You don't have to worry about passing the filename, MsgEd will pass it at the
  177. end of the command-line when calling your editor. Also, just to be safe, I've
  178. found that adding these lines;
  179.  
  180. Switch Hardquote On
  181. Switch ExtFormat Off
  182.  
  183. will prevent MsgEd from re-formatting the quote (and your PGP mail in the
  184. process) and allows PGP to decrypt messages properly.
  185.  
  186. Use With Golded:
  187. ~~~~~~~~~~~~~~~~
  188.     For use with GoldEd, you must add atleast one line to the config file, you
  189. could also add any of several other lines to make your life easier, but those
  190. are up to you. The line you will need looks something like this;
  191.  
  192. EDITOR D:\PATH\TO\GOPGP\GOPGP.EXE @FILE /E
  193.  
  194. The "/E" just makes it jump directly into the message editor (VERY convenient)
  195. which is optional. If you would like to be able to use GOPGP's macro functions
  196. but want to use your internal editor for certain messages, you can add the
  197. following to your config file also;
  198.  
  199. EXTERNOPTIONS -nokeepctrl -wipe -PauseOnError
  200.  
  201. EXTERNUTIL 1 D:\PATH\TO\GOPGP\GOPGP.EXE @TMPFILE /S
  202. EXTERNUTIL 2 D:\PATH\TO\GOPGP\GOPGP.EXE @TMPFILE /N
  203. EXTERNUTIL 3 D:\PATH\TO\GOPGP\GOPGP.EXE @TMPFILE /A
  204. EXTERNUTIL 4 D:\PATH\TO\GOPGP\GOPGP.EXE @TMPFILE /D
  205. EXTERNUTIL 5 D:\PATH\TO\GOPGP\GOPGP.EXE @FILE
  206.  
  207. EDITSAVEUTIL 1 "S PGP Sign the msg"
  208. EDITSAVEUTIL 2 "E PGP Encrypt the msg"
  209. EDITSAVEUTIL 3 "T PGP EncrypT & Sign the msg"
  210. EDITSAVEUTIL 5 "P GOPGP"
  211.  
  212. Also, add the following to GOLDKEYS.CFG:
  213.  
  214. F11    ExternUtil02  ; Press F11 to Encrypt a message
  215. F12    ExternUtil04  ; Press F12 to decrypt the current message.
  216.  
  217. With this set-up, the first difference you will notice is when you enter a new
  218. message. On the menu that comes up, you will see Internal Editor AND External
  219. Editor, if you select External Editor, you will be brought to GOPGP, and into
  220. your message editor (If you use the "/E" switch) With the latter portions of the
  221. config file I've included, you will have several new options on your "Save
  222. Message" menu. You will now see "Sign Message", "Encrypt Message", "Encrypt &
  223. Sign Message" and "GOPGP". As for the portions to add to the GOLDKEYS.CFG, as
  224. you can see by the comments above, when you are viewing an encrypted message,
  225. you simply press F12 to decrypt it, and if you are viewing a 'normal' message,
  226. you can simply press F11 to encrypt the message.
  227.  
  228. Use With Other Programs:
  229. ~~~~~~~~~~~~~~~~~~~~~~~~
  230.     If you use a program for your mail that isn't listed in these DOC's,
  231. please, by all means, send me a detailed set of setup instructions (IE: How you
  232. got it to work) at my E-Mail address (found in "Contacting Me") so that I may
  233. include it in the DOC's for the next version, and maybe make someone's life a
  234. lot easier. After all, I can't know how to set this up for programs I don't run,
  235. right?
  236.  
  237.     About the only thing I can suggest you do to run this with another program
  238. is, make sure your program isn't reformating the message at any time, and use
  239. some common sense when it comes to the command-line switches. I don't see any
  240. reason why this can't run under any program that allows an external editor.
  241.  
  242. Internal File Viewer:
  243. ~~~~~~~~~~~~~~~~~~~~~
  244.     The internal file viewer is quite simple to use, when you start the
  245. internal viewer, there are several keystrokes which can be used to move around,
  246. and to adopt taglines. The following keys can be used to move around, and are
  247. very straightforward: Up, Down, PageUp, PageDown, Home, and End. To adopt a
  248. tagline from the screen to the end of your defined tagline file, press Alt-A. To
  249. quit the viewer, simply press Esc.
  250.  
  251. Signatures:
  252. ~~~~~~~~~~~
  253.     A signature file is a plain ASCII text file that will be added to the end
  254. of your messages (unless you have signatures disabled). If you would like, you
  255. can put one or more of three macro's in your signature file. If you put @T@ in
  256. your signature file, it will be replaced with the current time (HH:MM:SS), if
  257. you put @D@ in your signature file, it will be replaced with the current date
  258. (MM/DD/YYYY), and if you put @DOW@ in your signature, it will be replaced with
  259. the day of the week (Sunday, Monday, etc..). For example: "@DOW@, @D@" would
  260. expand to: "Sunday, 12/21/1997", and: "Written @DOW@, @D@ at @T@" would expand
  261. to: "Written Sunday, 12/21/1997 at 12:30:45"
  262.  
  263. Key Management:
  264. ~~~~~~~~~~~~~~~
  265.     The key management menu harnessess most of PGP's key management features,
  266. such as; adopting public keys from the message, appending your public key to the
  267. message, viewing your public keyring, removing keys from your public keyring,
  268. editing your secret key (passphrase, adding usernames, or editing the trust
  269. parameters on your public key) generating a key pair, and revoking your key.
  270. NOTE!! Revoking your key is fairly serious, because once it's been revoked, if
  271. people send you encrypted mail with that key, you will not be able to decrypt
  272. it. So to revoke your key, you must type "IAGREE" (without the quotes) to
  273. confirm that you do infact wish to permanently revoke your key.
  274.  
  275. Tagline Selection:
  276. ~~~~~~~~~~~~~~~~~~
  277.     Here is a brief explanation of all the items on the tagline selection menu:
  278.  
  279. Y - Use This Tagline
  280.     Pressing Y or ENTER will accept the current options. IE: The tagline,
  281.     signature, etc..
  282.  
  283. N - Select New Tagline
  284.     Select a new random tagline from the current tagfile
  285.  
  286. L - List Ten
  287.     Selects ten random taglines and prompts you to select one of them, list 
  288.     another ten, or abort (keep current tag).
  289.  
  290. Q - Quit, No Tag or Sig
  291.     Pressing Q or ESC aborts, and adds no signature or tagline.
  292.  
  293. C - Change Tagfile
  294.     If you specified a valid path for the "Path where tag/sigfiles are stored"
  295.     this will bring up a list of all files named *.TAG within that path. (Only
  296.     the first 26 tagfiles found will be listed) Otherwise it will bring up a
  297.     prompt asking you to type in the name of the new tagline file.
  298.  
  299. S - Change Sigfile
  300.     As above, if the path for "Path where tag/sigfiles are stored" contains any
  301.     files named *.SIG it will bring up a list of these signatures and prompt you
  302.     for your selection (Only the first 10 sigfiles found will be listed).
  303.     Otherwise it will prompt you for the path and filename of the new sigfile.
  304.  
  305. T - What To Add
  306.     This simply selects whether you would like to add TAG only, SIG only, or
  307.     BOTH. (Defaults to BOTH)
  308.  
  309. R - Run Spell-Checker
  310.     If you have the spell checker option set, this item will run it. Unlike the
  311.     "After Edit" utility (run after EVERY message) this will only be run when
  312.     you press 'R' from this menu.
  313.  
  314. UU Encoding/Decoding:
  315. ~~~~~~~~~~~~~~~~~~~~~
  316.     Support has just been added for UU Encoding/Decoding files. When you decode
  317. a file from your message, GOPGP will be able to UUDecode the file ONLY if there
  318. are A) No quote characters at the beginning of the lines, or B) The quote
  319. characters are standard (IE: A ">" characters followed by a space, then the
  320. message text. This could also include initials in front of it, like " SH> ", but
  321. there *MUST* be a ">" symbol followed by a space!).
  322.  
  323.     Also - Since I'm not psychic, to UUDecode a file, it must be in ONE message
  324. (With NO blank lines between the "Begin 644 <filename>" and the word "end"). If
  325. you do receive a UUEncoded file that gets split into several messages, you can
  326. simply use a text editor to combine the UUENcoded messages into one text file,
  327. then run GOPGP with the command line "GOPGP <textfilename>" and decode the
  328. message from there.
  329.  
  330.     Also, please keep in mind that when UUEncoding files into your message, it
  331. will all be put into one single message, so UUEncoding a 3 MEG file would make
  332. for one LONG message.
  333.  
  334. Restrictions:
  335. ~~~~~~~~~~~~~
  336.     If you are using the OS/2 version, you *MUST* also use the OS/2 version of
  337. PGP and an OS/2 specific text editor. But why bother using DOS apps under OS/2
  338. if you don't have to? If you don't want to use the OS/2 version of PGP, you
  339. COULD run the DOS version of GOPGP under OS/2, with a DOS text editor and the
  340. DOS version of PGP. I'll look for a way to get around this in future versions,
  341. providing I get enough user-feedback in support of it.
  342.  
  343. Version Numbering:
  344. ~~~~~~~~~~~~~~~~~~
  345.     Just incase anyone is wondering how I number each version, the version
  346. scheme is very simple. When I first started the program, I used version numbers
  347. 1.00ß1 through 1.00ß5, until the first release which was version 1.00. The
  348. version scheme I use now goes as follows - Public releases will be numbered in
  349. increments of one tenth from the previous release (IE: 1.10, 1.20, 1.30, etc..)
  350. and the beta versions will be incremented one hundredth from the last public
  351. release (IE: 1.02, 1.03, etc..)
  352.  
  353. Error Messages:
  354. ~~~~~~~~~~~~~~~
  355.     If the program halts with an error message, it will also create a file in 
  356. the program directory called ERROR.LOG. If you do see this log file, please send
  357. it to the me immediately, as it will contain enough information for me to find,
  358. and possibly solve, the problem.
  359.  
  360. Contacting Me:
  361. ~~~~~~~~~~~~~~
  362.     If you want to get ahold of me, for bug reports, or for features you would
  363. like to see added/changed, or just to drop me a line to tell me you are using
  364. this program (and like it), you can send me Internet E-Mail at
  365. blackdeath@tinys.oix.com (no file-attaches) or s_honsberger@usa.net (file
  366. attaches allowed) or you could visit me at my web page at:
  367. http://tinys.oix.com/blackdeath and I'll do my best to help you out. I've
  368. included my PGP public key in this archive in the file STEWART.KEY, if you wish
  369. to encrypt your message to me.
  370.  
  371. Credits:
  372. ~~~~~~~~
  373.     Just want to give thanks to Shawn 'Tiny' Highfield for Beta testing for me
  374. all this time.
  375.