1MKAF(1)                     General Commands Manual                    MKAF(1)
2
3
4

NAME

6       mkaf - create a Performance Co-Pilot archive folio
7

SYNOPSIS

9       $PCP_BINADM_DIR/mkaf [-?]  [findopts] filename ...
10

DESCRIPTION

12       A  collection of one or more Performance Co-Pilot (see PCPIntro(1)) ar‐
13       chives may be combined with mkaf to produce a PCP archive folio and the
14       associated archive folio control file.  Some PCP tools use mkaf to cre‐
15       ate archive folios, e.g. the ``record'' facility in the pmchart(1)  and
16       pmview(1) tools, to facilitate playback with pmafm(1).
17
18       mkaf  processes each filename argument, and if this is a component file
19       from a PCP archive that archive is added to the folio.
20
21       If filename is a directory, then this  is  searched  recursively  using
22       find(1).  Any filename argument beginning with a ``-'' is assumed to be
23       a find(1) command line option (findopts); the default is -follow if  no
24       findopts are specified.
25
26       The  first  named archive in the folio is assumed to be associated with
27       the default host for any tool that tries to  replay  multiple  archives
28       from the folio.
29
30       The  folio control file is written to standard output, and has the fol‐
31       lowing format.
32
33       1. The first line contains the word PCPFolio.
34
35       2. The second line contains the tag Version:  followed  by  the  format
36          version number (currently 1).
37
38       3. For subsequent lines, blank lines and lines beginning with ``#'' are
39          ignored.
40
41       4. The line beginning with the tag Created: documents  where  and  when
42          the folio was created.
43
44       5. The  line  beginning with the tag Creator: identifies the tool which
45          created the folio (and is assumed to know how to replay the  archive
46          folio).  If present, the second argument is the name of a configura‐
47          tion file that the creator tool could use to replay the archive  fo‐
48          lio, e.g. with the replay command for pmafm(1).  In the case of mkaf
49          (unlike pmchart(1) or pmview(1)) there is no knowledge of  the  con‐
50          tents of the archives, so the ``creator'' cannot replay the archive,
51          however pmchart(1) is able to replay any archive, and so  this  tool
52          is identified as the Creator: for archive folios created by mkaf(1).
53
54       6. This  is  then  followed by one or more lines beginning with the tag
55          Archive: followed by the hostname and base name of the archive.
56
57       For example
58            $ mkaf mydir/gonzo
59       might produce the following folio control file.
60
61       PCPFolio
62       Version: 1
63       # use pmafm(1) to process this PCP archive folio
64       #
65       Created: on gonzo at Tue Jul  2 03:35:54 EST 1996
66       Creator: pmchart
67       #               Host                    Basename
68       #
69       Archive:        gonzo                   mydir/gonzo/960627
70       Archive:        gonzo                   mydir/gonzo/960628
71       Archive:        gonzo                   mydir/gonzo/960629
72       Archive:        gonzo                   mydir/gonzo/960630
73       Archive:        gonzo                   mydir/gonzo/960701
74       Archive:        gonzo                   mydir/gonzo/960701.00.10
75       Archive:        gonzo                   mydir/gonzo/960701.05.25
76       Archive:        gonzo                   mydir/gonzo/960702.00.10
77

OPTIONS

79       The available command line options are:
80
81       -?   Display usage message and exit.
82
83       -findopts
84            Options to be passed to find(1).  The default is -follow.
85

DIAGNOSTICS

87       Some informational messages, warnings and pathological  conditions  are
88       reported on standard error.
89

PCP ENVIRONMENT

91       Environment variables with the prefix PCP_ are used to parameterize the
92       file and directory names used by PCP.  On each installation,  the  file
93       /etc/pcp.conf  contains  the  local  values  for  these variables.  The
94       $PCP_CONF variable may be used to specify an alternative  configuration
95       file, as described in pcp.conf(5).
96

SEE ALSO

98       find(1),  PCPIntro(1), pmafm(1), pmchart(1), pmview(1), pcp.conf(5) and
99       pcp.env(5).
100
101
102
103Performance Co-Pilot                  PCP                              MKAF(1)
Impressum