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       chive logs may be combined with mkaf to produce a PCP archive folio and
14       the  associated archive folio control file.  Some PCP tools use mkaf to
15       create archive folios, e.g. the ``record'' facility in  the  pmchart(1)
16       and 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
48          folio,  e.g.  with  the replay command for pmafm(1).  In the case of
49          mkaf (unlike pmchart(1) or pmview(1)) there is no knowledge  of  the
50          contents  of  the archives, so the ``creator'' cannot replay the ar‐
51          chive, however pmchart(1) is able to replay any archive, and so this
52          tool  is  identified  as  the Creator: for archive folios created by
53          mkaf(1).
54
55       6. This is then followed by one or more lines beginning  with  the  tag
56          Archive: followed by the hostname and base name of the archive.
57
58       For example
59            $ mkaf mydir/gonzo
60       might produce the following folio control file.
61
62       PCPFolio
63       Version: 1
64       # use pmafm(1) to process this PCP archive folio
65       #
66       Created: on gonzo at Tue Jul  2 03:35:54 EST 1996
67       Creator: pmchart
68       #               Host                    Basename
69       #
70       Archive:        gonzo                   mydir/gonzo/960627
71       Archive:        gonzo                   mydir/gonzo/960628
72       Archive:        gonzo                   mydir/gonzo/960629
73       Archive:        gonzo                   mydir/gonzo/960630
74       Archive:        gonzo                   mydir/gonzo/960701
75       Archive:        gonzo                   mydir/gonzo/960701.00.10
76       Archive:        gonzo                   mydir/gonzo/960701.05.25
77       Archive:        gonzo                   mydir/gonzo/960702.00.10
78

OPTIONS

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

DIAGNOSTICS

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

PCP ENVIRONMENT

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

SEE ALSO

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