PF.DOC  ·  DOC  ·  5.3 KB  ·  1986-09-29  ·  from CompuLink-User-Group_Magazette_Vol-2-Issue-2_1986
                    Copyright (C) 1985, 1986 George Perfect
                                    Page: 1

     PF - Print File utility. Documentation for Version 1.05   30/06/1986 
                                       
                                       
                                  DESCRIPTION

    This document describes Release 1.05 of PF.EXE.

    PF.EXE  is a text file print routine designed to run under MS-DOS  2.xx  
    or  higher.  It  produces correctly paged listings of ASCII text  files 
    such  as program listings,  text documents etc.  on the  default  print 
    device.

    Although  MS-DOS is normally supplied with several utilities capable of 
    producing  printed  copies of text files,  the resulting hard  copy  is 
    often  messy - without page breaks and it is difficult  to  distinguish 
    between several drafts when working on a document or program.


SYSTEM REQUIREMENTS

    MS-DOS  or PC-DOS 2.0 or later.  128K memory,  printer which recognises 
    the form-feed character (ASCII 12).


USING PF

    Multiple files may be printed with a single command.  Each page has (by 
    default) a heading showing the filename,  current system time and  date 
    and the page number.  Optionally, a comment may be added to the heading 
    - useful for noting release numbers.  The file contents will be printed 
    within the boundaries of a page. 

    By default these are :-

    i)  Left margin                                         0
    ii)  Line width (characters)                            80
    iii)  Page depth (lines)                                60
    iv)  Tab spacing (characters)                           8

    Lines  which are too long to fit within the specified width are wrapped 
    on to succeeding lines. The program issues a form-feed character (ASCII 
    FF = decimal 12) to the printer at the end of each page.

    Within the file,  tab characters (ASCII HT = decimal 9) are expanded to 
    a  number  of  spaces;  form feed characters force  a  new  page  (with 
    headings).

    Command line options can disable page headings and line numbering.

    If wild card characters are used to specify the files to be printed, PF 
    will  sort the files in each group (ie,  each file specification on the 
    command  line) alphabetically.  If you want all files combined  into  a 
    single, sorted group use the '-g' option. For example, the command:

    pf *.h *.c

    will  print  all files ending in '.h' in sorted order followed  by  all 
    files  ending  in '.c' in sorted order.  Should the files  "FOO.H"  and 
    "FOO.C"  exist,  they  will  appear in separate  groups.  This  default 
    behaviour  is  useful for separating files by extension.  If  the  '-g' 
    option is given, files will be sorted as a single group so that "FOO.C" 
    and "FOO.H" will appear together in the printed listings.


    RUNNING PF

    Command line switches may be issued to override the default settings or 
    to select options. The command line format is:

    pf {-opt1 ... -optn} filespec1 {{-opt ...} filespec2 ...}

    Note  that  one file specification is required.  All  other  items  are 
    optional.  Entering  the 'pf' command without arguments will produce  a 
    help  display of available options - this explains the program's  usage 
    far more concisely than I can here.

    A  'filespec'  may be any valid MS-DOS 2.xx file name  specification  - 
    including full drive and path names,  wildcards etc. Wild cards will be 
    expanded to a full list of matching file names.  Multiple filespecs are 
    permitted on a single command line. 

    Options  must  be entered BEFORE the filespec(s) to which  they  refer. 
    Once set,  an option remains in force until all files have been printed 
    or  it  is  reset with another option switch.  Option  letters  may  be 
    entered as upper or lower case.


    PAPER JAMS

    Pressing  any key while PF is running causes output to  be  temporarily 
    suspended.  Options  are  then provided to abort the entire print  run; 
    skip the current file and proceed with the next (useful if a  wild-card 
    specification produces something unexpected); re-print the current file 
    from  the  start and continue with the remainder of the run or  lastly, 
    continue printing the current file.


    AUTHOR

    PF  was  written  by George Perfect and copyright  to  the  program  is 
    retained. You are free to use the program and to make copies for backup 
    or  to  pass  on  to  friends BUT,  the program  may  not  be  sold  or 
    distributed commercially or for profit. Commercial users are invited to 
    send  contributions for the program to the author at the address below. 
    All  such  contributions will be  donated  to  charity.  Otherwise,  no 
    payment is required and no warranty is given!  I invite any comments on 
    the program and my address is:-

    George Perfect
    22 Fatfield Park
    Washington
    Tyne & Wear
    NE38 8BW
    ENGLAND

    BIX id: gperfect
    Telecom Gold (Dialcom): 84:DDS002

    I hope you find the program as useful as I have.