[net.sources] PPERT the man page

jchvr@ihlpg.UUCP (VanRietschote) (04/29/86)

#-- cut here file= ppert.man
.TH PPERT 1 "HFVR"
.SH NAME
.\" name \- one-line description for in permuted index
ppert \- to print pert graphs from unity database
.SH SYNOPSIS
.\" bnf on command syntax
ppert [-douwlivsncaATI] [-f input]
.SH DESCRIPTION
.\" semantics
ppert takes its input from a file which consists of item
descriptions. Each item description is terminiated by a carriage
return. Each item consists of at least the following fields (in the
given order).
.sp
.in +9
.ti -9
.tr ?
id???????unique identifier of item. Max length 16. All printing
ASCII are allowed as identifier except for SPACE and '~'.
.sp
.ti -9
status???either 'ready' or something else.
.sp
.ti -9
start????start week. Need not be filled in if after is filled in.
However if filled in then after is not used.
.sp
.ti -9
duration?number of weeks that the item will take to complete.
.sp
.ti -9
after????list of id's of items that need to be done before this
item can start. The items are separated by either SPACES or '~'.
.sp
.ti -9
end??????number of end week. Should be filled in if status=ready.
.sp
.ti -9
title????a maximum 32 character title for this item. Any character are
allowed expect TAB.
.in -9
.sp
More fields after these may be given and are ignored by ppert. A
unity descriptor file for the pert-file would be:
.sp
.nf
        id      t\\t     16l      ID
        status  t\\t     6l      STATUS
        start   t\\t     5r      START
        duration        t\\t     8r      DURATION
        after   t\\t     9l      AFTER
        end     t\\t     3r      END
        title   t\\t     32l     TITLE
        ...     t\\n     ...     ...

.fi
.SH OPTIONS
.tr ~
.in +6
.sp
.ti -6
-d~~~~turns on debug mode. This will show all items as they are
read and also a list of all options and their values. Default is
off.
.sp
.ti -6
-o~~~~this option takes as argument a filename. If given a list of
all items is printed together with the calculated start and end weeks.
The format of this file is unity compatible:
.sp
.nf
       id     t\\t      16l
       start  t\\t      3r
       end    t\\n      3r
.fi
.sp
.ti -6
-u~~~~this option will prevent the printing of the 'uitloop' weeks,
which are indicated by '....' in the output. By default the
\&'uitloop' is printed with '....'
.sp
.ti -6
-w~~~~turns off printing of warnings messages. Be careful about
turning this off. Default is on.
.sp
.ti -6
-l~~~~this option will make sure that all dependencies are printed
above the item needing them, even if they have already been printed
once. The default is that items are printed only once.
.sp
.ti -6
-i~~~~takes as argument an item-id. This item is then printed
instead of the default. The default is the first item in the
database.
.sp
.ti -6
-v~~~~prints version number and exit. This is not the default
action.
.sp
.ti -6
-s~~~~takes a week number as argument and makes it  the week at
which to start printing. Default is 501.
.sp
.ti -6
-n~~~~takes an integer as argument and makes it the number of weeks
that need to be printed. Default is 12.
.sp
.ti -6
-c~~~~takes an integer as argument and makes it the incremenmt in which weeks
areprinted. Default is 1 (so every week is printed).
.sp
.ti -6
-a~~~~forces all items that are not ready to be printed. 
The default is to print only
those items that either start or finish in the printing window.
.sp
.ti -6
-A~~~~forces all items to be printed. Even those that are ready.
.sp
.ti -6
-T~~~~takes as argument the printlength of the TITLE field in the output.
This does not influence the inputlength. Default 12. Minimum 5.
.sp
.ti -6
-I~~~~takes as argument the printlength of the ID field in the output.
This does not influence the inputlength. Default 8. Minimum 2.
.sp
.ti -6
-f~~~~takes as argument the name of the input file. Default is the
file 'pert' in the current directory.
.in -6
.tr ~~
.SH EXAMPLES
.nf
ppert                   # to print file pert with all defaults
ppert -f planning       # print pert contained in the file planning
ppert -s530             # print pert starting at week 530
ppert -I2 -T20          # print pert with different sizes in output
.fi
.sp
If item 0 depends on 1 and 2. And item 1 depends on 11, 12 and 13.
And item 2 depends on 21. Then the datafile could look like:
.sp
.nf
|---------------------------------------------------------|
|id      |status|start|duration|after    |end|title       |
|---------------------------------------------------------|
|0       |      |     |0       | 1 2     |   |nul         |
|1       |      |     |1       |11 12 13 |   |een         |
|2       |      |     |2       |21       |   |twee        |
|11      |      |500  |1       |         |   |eeneen      |
|12      |      |501  |2       |         |   |eentwee     |
|13      |      |502  |3       |         |   |eendrie     |
|21      |      |504  |4       |         |   |twee een    |
|---------------------------------------------------------|

The output from 'ppert -s500' would be:

                              Dec Jan             Feb             Mar         
ID       TITLE        STR END 500 501 502 503 504 505 506 507 508 509 
21       twee een     504 507                 ----------------
2        twee         508 509                                 --------
13       eendrie      502 504         ------------
12       eentwee      501 502     --------........
11       eeneen       500 500 ----................
1        een          505 505                     ----................
0        nul              509                                         

.fi
.SH FILES
.nf
pert                    # unity file containing items
Dpert                   # unity descriptor file (not needed)
.fi
.SH SEE ALSO
unity(1)
.SH DIAGNOSTICS
ppert tries very hard to detect all errors and aborts if too many
serious errors are found.
.SH WARNINGS
ppert will produce warnings in all cases where an field does not
fit into the allowed space or if carriage returns are missing.
These warning messages can be turned of with the -w option.
.SH VERSIONS
.nf
Version 1.01 : checks that all id's are unique.
               progam now works between 1985 and 1995
	       circular dependencies are caught
.fi
.SH BUGS
The program will not work after 1994 or before 1985.
.sp
Items with duration =0 are allowed but get a funny treatement.