home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / pfe101.zip / README.TXT < prev    next >
Text File  |  1999-01-20  |  12KB  |  301 lines
  1.                     Programmer's File Editor 1.01
  2.                     -----------------------------
  3.  
  4. Welcome to Programmer's File Editor. This file is the place to start looking at
  5. the program: if you've not seen PFE before there's a synopsis of its main
  6. features; and if you've used earlier versions there's some essential
  7. information on major changes.
  8.  
  9. Below you'll find
  10.  
  11.     1. ABSTRACT
  12.         A brief list of PFE's main features
  13.     2. USING AND DISTRIBUTING PFE
  14.         The terms on which you can use it and pass it on
  15.     3. CONTACTING THE AUTHOR
  16.         How to pass on your criticisms, suggestions, bug reports
  17.         and maybe even praise
  18.     4. WHERE TO GET PFE
  19.         Places to look for PFE on the Internet and elsewhere
  20.     5. WHICH VERSION SHOULD YOU USE?
  21.         How to pick the most appropriate version
  22.     6. UPGRADING FROM PREVIOUS RELEASES
  23.         Important information if you're currently using an older
  24.         version of PFE
  25.     7. OTHER FILES YOU SHOULD LOOK AT
  26.         The other important text files in this release
  27.     8. THE FILES YOU SHOULD GET
  28.         What should be in your distribution set
  29.     9. INSTALLING PFE
  30.         How to install everything
  31.  
  32. ---
  33.  
  34. Alan Phillips    ( A.Phillips@lancaster.ac.uk )
  35.         ( http://www.lancs.ac.uk/people/cpaap/pfe )
  36.  
  37.  
  38. -------------------------------------------------------------------------------
  39.  
  40.  
  41. 1. ABSTRACT
  42. -----------
  43.  
  44. This is the 1.01 release of Programmer's File Editor, a large-capacity
  45. multi-file programming oriented editor for Windows 95, Windows 98,
  46. Windows NT 3.51 and 4.0 on Intel platforms, Windows 2000 on Intel platforms,
  47. and Windows 3.1x
  48.  
  49. PFE includes the following features:
  50.  
  51. - The size of file it can handle is limited only by the total amount of
  52.   virtual memory available
  53. - No arbitrary limit on the number of lines a file can contain
  54. - It can edit multiple files, the number being limited only by the
  55.   available system resources
  56. - Allows multiple edit windows showing the same file
  57. - Multi-level undo facility
  58. - Can read and write files in UNIX format using LF as line terminator, with
  59.   automatic format detection
  60. - Line numbers can be shown in any edit window if required
  61. - Text can be copied and moved by dragging and dropping
  62. - Right-click mouse menus give access to commonly required functions
  63. - DOS commands such as compilers can be run with the output captured
  64.   in an edit window
  65. - Commonly-used text can be inserted in a simple operation from template
  66.   libraries
  67. - Fully-remappable keyboard, including two-key operation similar to MicroEMACS
  68.   and mapping of Alt keys to functions
  69. - Keystrokes and menu commands can be recorded in replayable keyboard macros
  70.   which can be collected into libraries
  71. - Files can be printed either in total, by line range, or selected text only
  72. - Files can be printed with two pages per sheet of paper in landscape mode
  73.   or as booklets
  74. - Automatic line indenting and removal of trailing spaces
  75. - Automatic configuration of edit options depending on file type
  76. - Automatic configuration of tab sizes depending on file type
  77. - Automatic brace alignment when editing C source
  78. - Text indent/undent operations
  79. - Optional automatic text wrapping at configurable margin
  80. - Supports Microsoft IntelliMouse (32-Bit Edition)
  81. - Floating Control Station to manage large numbers of open files (32-Bit
  82.   Edition)
  83.  
  84. Additionally, the editor can be controlled by another application across a
  85. DDE client-server link.
  86.  
  87. 2. USING AND DISTRIBUTING PFE
  88. -----------------------------
  89.  
  90. PFE may be used in any way, for any purpose, at no cost. In may be distributed
  91. by any means, provided that the original files as supplied by the author remain
  92. intact and no charge is made other than for reasonable distribution costs.
  93.  
  94. You do not need to register to use PFE, or buy a licence to use it
  95.  
  96. PFE may be placed on any archive or BBS system
  97.  
  98. PFE may not be distributed with any commercial product without a prior license
  99. agreement with the author
  100.  
  101. 3. CONTACTING THE AUTHOR
  102. ------------------------
  103.  
  104. I would very much appreciate hearing from you if you use PFE and find problems,
  105. or if you can think of ways it could be improved - and even (or is that
  106. 'especially'?) if you just think it's great. Even if the facility you would
  107. like to see appears to be of interest only to you, tell me about it - you'd be
  108. surprised how many ideas in that class have a much wider appeal.
  109.  
  110. You can contact me by e-mail at
  111.  
  112.                     A.Phillips@lancaster.ac.uk
  113.  
  114. I read and consider all the mail I receive, even though I may not have time
  115. to reply
  116.  
  117. You'll find up-to-date information on PFE, including new versions and a series
  118. of Application Notes discussing usage problems on the web at
  119.  
  120.         http://www.lancs.ac.uk/people/cpaap/pfe/
  121.  
  122. 4. WHERE TO GET PFE
  123. -------------------
  124.  
  125. The current version of PFE is distributed in two ZIP files. The names they have
  126. when they are sent out are these:
  127.  
  128.    pfe101i.zip         The 32-bit edition for Windows 95, Windows 98,
  129.                        Windows NT 3.51 and 4.0 on Intel platforms,
  130.                        Windows 2000 on Intel platforms
  131.    pfe101.zip          The 16-bit edition for Windows 3.1x
  132.  
  133. There is no implementation of this version for Windows NT on PowerPC systems.
  134. However, version 0.07.001 is available for this platform in a file that should
  135. have the name pfe0701p.zip
  136.  
  137. The distribution files will end up on archives all over the Internet, so a
  138. search for these file names will probably show them somewehere.
  139.  
  140. The definitive source for new releases, news and useful information is the PFE
  141. Home Page on the World Wide Web; the URL is
  142.  
  143.                 http://www.lancs.ac.uk/people/cpaap/pfe/
  144.  
  145. Feel free to create links to this page from your own web site if you desire.
  146.  
  147. 5. WHICH VERSION SHOULD YOU USE?
  148. -------------------------------
  149.  
  150. Although the various editions of PFE will run on platforms other than their
  151. intended ones, not all facilities will be available in some combinations. For
  152. the best result, you should use the versions recommended here:
  153.  
  154.     System                Edition To Use
  155.     ------                --------------
  156.     Windows 95            32-Bit Edition
  157.     Windows 98            32-Bit Edition
  158.     Windows NT 4.0 Intel        32-Bit Edition
  159.     Windows NT 3.51 Intel        32-Bit Edition
  160.     Windows 2000 Intel        32-Bit Edition
  161.     Windows 3.1x            16-Bit Edition
  162.  
  163. [Note that in this context "Intel" means genuine Intel processors and Intel-
  164. compatibles such as the Cyrix and AMD chipsets]
  165.  
  166. 6. UPGRADING FROM PREVIOUS RELEASES
  167. -----------------------------------
  168.  
  169. If you've been using PFE version 0.07.001, 0.07.002 or 1.00, then you
  170. won't need to take any special steps to move to 1.01
  171.  
  172. However, if you've been using 0.06.002 or earlier, take a moment to read the
  173. notes below, as there have been some significant changes that you need to
  174. consider before you install the new version.
  175.  
  176. FOR 32-BIT EDITION USERS ONLY
  177.  
  178. If you've been using 0.06.002 or earlier of the 32-Bit Edition under Windows
  179. 95, Windows 98, Windows NT or Windows 2000, then you'll probably want to take
  180. some installation steps before you start to run the new version of PFE. 
  181.  
  182. PFE now uses the Windows Registry to store configuration information rather
  183. than the PFE32.INI initialisation file; this allows it to support per-user
  184. configuration data and offer some extra facilities.
  185.  
  186. The INI2REG utility allows you to convert existing initialisation files into
  187. the Windows Registry and explains the new facilities. You should read the text
  188. file UPGRADE.TXT that is part of the distribution set for complete details
  189.  
  190. FOR ALL USERS
  191.  
  192. PFE now sets up associations for the file types you want to use it with itself,
  193. using the Options Preferences command. You should begin by using this command
  194. to define your associations, as this will guarantee that they are correctly
  195. defined, and also enable some context menu support for the 32-Bit Edition. Note
  196. that your manually-defined associations will not be shown by PFE when you do
  197. this.
  198.  
  199. If you're upgrading from version 0.05.007 or earlier, it's best to delete your
  200. existing initialisation files (PFE.INI or PFE32.INI) and begin again with the
  201. new release.
  202.  
  203. 7. OTHER FILES YOU SHOULD LOOK AT
  204. ---------------------------------
  205.  
  206. The distribution set contains several other text files of important
  207. information.
  208.  
  209. For the answers to some of the common questions that users have, see FAQ.TXT.
  210. Looking in here can save you a lot of worry and experimentation, and save you
  211. from posting your question to newsgroups and mailing lists.
  212.  
  213. The CHANGES.TXT file tells you what's changed from earlier releases. If you
  214. find something unexpected going on, look in here too - it could be a feature
  215. rather than a bug.
  216.  
  217. The PROBLEMS.TXT file tells you about any major problems that were discovered
  218. too late to be addressed in this release, and what you can do if you hit them.
  219.  
  220. The YEAR2000.TXT file tells you about Year 2000 issues affecting PFE.
  221.  
  222. 8. THE FILES YOU SHOULD GET
  223. ---------------------------
  224.  
  225. There are a small number of files in the PFE distribution. You should find the
  226. following items:
  227.  
  228. 32-bit Intel and Intel-compatibles Edition:
  229.  
  230.     [For Windows 95, Windows 98, Windows NT 3.51 and 4.0 on Intel platforms
  231.          and Windows 2000 on Intel platforms]
  232.  
  233.     pfe32.exe        The editor itself
  234.     pfe.hlp            The help file
  235.     pfedos32.exe        A helper module, needed to run commands and
  236.                 capture output
  237.     readme.txt        This file
  238.     upgrade.txt        Details on how to convert your initialisation
  239.                 files into the Windows Registry if you're
  240.                                 currently using version 0.06.002 or earlier
  241.     ini2reg.exe        The program that converts your initialisation
  242.                 files into the Windows Registry
  243.     changes.txt        Changes from previous releases
  244.     faq.txt            Frequently Asked Questions
  245.     problems.txt        Information on late-breaking problems
  246.     year2000.txt        Information on Year 2000 issues
  247.  
  248. 16-bit Edition:
  249.  
  250.     [For Windows 3.1x]
  251.  
  252.     pfe.exe            The editor itself
  253.     pfe.hlp            The help file
  254.     pfedos.exe        A helper module, needed to run commands and
  255.                 capture output
  256.     pfedos.pif        The PIF file for this module
  257.     readme.txt        This file
  258.     changes.txt        Changes from previous releases
  259.     faq.txt            Frequently Asked Questions
  260.     problems.txt        Information on late-breaking problems
  261.     year2000.txt        Information on Year 2000 issues
  262.  
  263. [The help file pfe.hlp is identical for the 16-bit and 32-bit editions]
  264.  
  265. 9. INSTALLING PFE
  266. -----------------
  267.  
  268. There is no setup program for PFE, as it doesn't really need one. Installation
  269. is done by simply copying the supplied files:
  270.  
  271. 32-bit Edition:
  272.  
  273.  Copy pfe32.exe, pfe.hlp, pfedos32.exe to a suitable directory. This need not
  274.  be on your path; but it's important that all the files are in the same
  275.  directory.
  276.  
  277.  Next, read upgrade.txt carefully, and if you wish, use the ini2reg utility to
  278.  convert your existing initialisation file PFE32.INI into the Windows Registry
  279.  
  280.  If you like to have PFE handy on your desktop, make sure that you place a
  281.  shortcut there, rather than a copy of the program file itself. If you make a
  282.  copy, you'll find that you can't run DOS commands, since the pfe.exe executable
  283.  will be in the desktop directory, and the pfedos32.exe helper module will be
  284.  somewhere else.
  285.  
  286. 16-bit Edition:
  287.  
  288.  Copy pfe.exe, pfe.hlp, pfedos.exe and pfedos.pif to a suitable directory.
  289.  This need not be on your path; but it's important that all the files are
  290.  in the same directory.
  291.  
  292.  
  293. It's a good idea to keep the 16-bit and 32-bit editions in the same place; then
  294. you will need only one copy of the help file.
  295.  
  296. After you've installed PFE, the best thing to do is start it up, then use the
  297. Options Preferences command to explore the customisation options and set it up
  298. to run as you prefer.
  299.  
  300.  
  301.