home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 554b.lha / WFile_v1.10 / wfile.hlp < prev    next >
Text File  |  1991-09-09  |  8KB  |  180 lines
  1.  
  2.  
  3. WFile - WorkFile - work (do things) on (ASCII-)files
  4. ----------------------------------------------------
  5. Version 1.10 - Freely distributable as long as it is used in non-commercial
  6. products.
  7.  
  8.  
  9. WFile takes one (1 in the current version, more in later versions) file and
  10. processes certain characters in it. Tabs can be expanded to multiple
  11. spaces, multiple spaces can be shrinked into one tab. Newline characters
  12. can be expanded by a CR code (usual on MS-DOS machines) or MS-DOS
  13. file-newlines can be stripped to a single LF code (usual on Amiga and UNIX
  14. machines). Foreign characters (German Umlaute for example) can be changed
  15. to the character set of another machine.
  16.  
  17. WFile provides a number of built-in templates to adapt files between
  18. AmigaDOS, MS-DOS and UNIX machines. This allows the user to adapt a file
  19. quickly without knowing the different ASCII-codes on each system.
  20.  
  21. Type wfile without any parameters to see how to invoke WFile. Parameters in
  22. <> brackets have to be specified, those in [] brackets are optional.
  23. Parameters divided by a | can be replaced by each other, i.e. one of those
  24. parameters have to be specified.
  25.  
  26. Here are some more facts concerning the parameters:
  27.  
  28. file -               name of the file to be processed. WFile
  29.                automatically backs up the original file by adding
  30.                the extension .bak to it. (The MS-DOS version changes
  31.                a present extension to .bak.) You could switch this
  32.                off by setting the -b option (no backup).
  33.  
  34. -?   -               displays this help text and exits. All other
  35.                parameters are ignored.
  36.  
  37. +|-CR     -           adds (+) or removes (-) the CR character ($0d) before
  38.                a LF character ($0a). In AmigaDOS and UNIX a newline
  39.                is represented by a single LF character, on MS-DOS
  40.                systems a newline is represented by a CR and a LF
  41.                character.
  42.  
  43. +|-T[tabsize] -        +T shrinks multiple spaces (number can be specified
  44.                by the optional tabsize parameter) to one tab.
  45.                -T expands one tab to multiple spaces.
  46.                If no tabsize parameter is given a tabsize of 8 is
  47.                assumed.
  48.                WFile regards tabs as fixed tabs, that means that
  49.                tabstops start at fixed positions. Example: If you
  50.                have a tabsize of 8 and the first two characters are
  51.                two slashes (//) the next tab will advance the
  52.                cursor to file position 8 (next tabstop) and not 10
  53.                (fileposition + tabsize).
  54.  
  55. -ddd=ddd           exchange characters
  56.                With this option you can adapt foreign symbols
  57.                (German Umlaute for example) from one system to
  58.                another since they have different ASCII codes on
  59.                each system. With -246=148 you can adapt the German
  60.                oe on Amiga systems to an oe on MSDOS systems.
  61.                You could also delete characters like an oe if you
  62.                say -246=0. To exchange the ASCII value 246 against
  63.                the ASCII value null (0) you have also to specify
  64.                the -0 option (see below)
  65.  
  66. -0               treat 0 as an ASCII value
  67.                If you want to *EXCHANGE* anything with a \0 rather
  68.                than deleting a character you have to set the -0
  69.                option, otherwise the 0 would be treated as a remove
  70.                command (see exchange characters above)
  71.  
  72. -b               do not create backup of the original.
  73.                Usually WFile creates a backup of the original file
  74.                to make sure that, in case of an error, you could
  75.                restore the original state. The backup file gets the
  76.                extension .bak.
  77.  
  78. -f[filename]           use a profile to enter commands.
  79.                With this powerful option you can specify a file
  80.                that may contain WFile options. This allows you to
  81.                save all your desired options in a file so that you
  82.                don't have to enter all the options every time you
  83.                use WFile. If you don't specify a file name, WFile
  84.                will look for the file "wfile.pro" to read. (see
  85.                below how to build a profile)
  86.  
  87. +ddd               add character to end of file
  88.                Some (strange) operating systems such as the famous
  89.                operating system bulit in (curiously enough) very
  90.                popular machines (starting with M..., I don't dare
  91.                to speak out the name) add a $1A code to the end of
  92.                each file. If you convert files from a real computer
  93.                to one of those systems you can enforce to add this
  94.                character with +26 (decimal value of $1A). You
  95.                could, of course, add any other (ASCII) value
  96.                between 0 and 255.
  97.  
  98. TEMPLATES: ----------
  99.  
  100. Generally: All options within a template are written to STDOUT to let you see
  101.        what's going on.
  102.  
  103. -AI  -               Amiga to IBM
  104.                This template changes foreign symbols (German
  105.                Umlaute in the current version) from the Amiga to
  106.                the enhanced IBM-ASCII set used in IBM PCs and its
  107.                clones. It also adds an CR code to the end of each
  108.                line.
  109.  
  110. -IA  -               IBM to Amiga
  111.                This templete changes foreign symbols (German
  112.                Umlaute in the current version) from the enhanced
  113.                IBM-ASCII set to MSDOS compatible systems to the
  114.                character set of the Amiga. The CR code at the ende
  115.                of each line will be stripped.
  116.  
  117. -AU  -               Amiga to UNIX
  118.                changes Amiga foreign symbols to their UNIX (HP
  119.                9000/825 HP-UX 7.0 SysV) equivalents (see above).
  120.  
  121. -UA  -               UNIX to Amiga
  122.                changes UNIX (HP 9000/825 HP-UX 7.0 SysV) foreign
  123.                symbols to their Amiga equivalents (see above).
  124.  
  125. -UI  -               UNIX to IBM.
  126.                changes foreign symbols from UNIX to the enhanced
  127.                IBM- ASCII set used in IBM PCs and its clones. It
  128.                also adds an CR code to the end of each line.
  129.  
  130. -IU  -               IBM to UNIX
  131.                changes foreign symbols from the enhanced IBM-ASCII
  132.                set on MSDOS compatible systems their equivalents
  133.                in UNIX.The CR code at the end of each line will be
  134.                stripped.
  135.  
  136.  
  137. PROFILES:
  138. ---------
  139.  
  140. Generally: All options within a profile are written to STDOUT to let you
  141.        see what's going on.
  142.  
  143. In a profile you can specify the options that WFile should use. You can
  144. keep any number of profiles, according to your needs. If you want to use a
  145. profile you must specify the -f option (see above) to let WFile know your
  146. commands come from a file. If no filename after the -f option is specified,
  147. WFile looks for a file named 'wfile.pro' in the current directory to read
  148. from. Amiga users should keep their wfile.pro file in the s: directory and
  149. invoke WFile with -fs:wfile.pro option.
  150.  
  151. A profile can contain any number of options as long as the general maximum
  152. for WFile commands is not exceeded. All templates (see above) may be used!
  153. In this case you should not specify the options within a template also by
  154. yourself. WFile might get confused if an option has to be processed twice.
  155.  
  156. Each option must stand in a single line. Each line MUST NOT contain more
  157. than 79 characters (currently there is no option, that is that long). Each
  158. line MUST end with a newline character ($0a on UNIX and Amiga, $0d$0a on
  159. MSDOS). Comment lines MUST have a # character as their first sign.
  160.  
  161. Example:
  162.  
  163. # don't enter the <newline> literally, just press return
  164. -t2  <newline>
  165. -UI  <newline>
  166. -b   <newline>
  167.  
  168. ---------------------------------------------------------------------------
  169. WFile is (C) Copyright 1991 by Joerg Fenin / Metalworx.
  170.  
  171. USE THIS PROGRAM AT YOUR OWN RISK!!
  172. There is no guarantee that WFile works properly. The author takes no
  173. responsibility for any damage that might result from the use of WFile.
  174.  
  175. This program may be distributed and used freely as long as no more than DM
  176. 5,- / US $ 5,- is charged for copying. It MUST NOT be part of any
  177. commercial product without the written permission of the author.
  178.  
  179.  
  180.