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

NAME

6       pmafm - Performance Co-Pilot archive folio manager
7

SYNOPSIS

9       pmafm folioname [command [arg ...]]
10

DESCRIPTION

12       A collection of one or more Performance Co-Pilot (PCP) archive logs may
13       be combined with a control file to produce a PCP  archive  folio.   Ar‐
14       chive  folios  are  created  using  either  mkaf(1)  or the interactive
15       ``record mode'' services of PCP clients like pmchart(1).
16
17       pmafm provides a number of services that may be used to process folios.
18       In particular, it provides support for execution of PCP tools using one
19       or more of the component archive logs within an archive folio.
20
21       The target folio is identified by the  folio  control  file  folioname.
22       The syntax for a folio control file is described in mkaf(1).
23
24       If  present,  the  command and arguments following folioname are inter‐
25       preted and executed as a single command, otherwise  commands  are  read
26       from standard input.
27
28       The following commands are supported.
29
30       archives
31              Subsequent commands apply to all archives in the folio.
32
33       archives N[,...]
34              Archives within a folio are numbered 1, 2, etc.  Subsequent com‐
35              mands are restricted to apply only to the designated archives.
36
37       archives name[,...]
38              Archives within a folio have unique names.  Subsequent  commands
39              are restricted to apply only to the designated archives.
40
41       check  Validate  the  presence and format of each file in the folio and
42              the component archives.
43
44       help
45              A brief reminder of the command syntax.  ?   is  a  synonym  for
46              help.
47
48       hosts
49              Subsequent commands apply to all archives in the folio.
50
51       hosts hostname[,...]
52              Subsequent  commands  are  restricted to apply only to those ar‐
53              chives that match the designated hostnames.
54
55       list [verbose]
56              Display the contents of  the  folio.   By  default  the  control
57              header  and  the  ordinal number, hostname and archive base name
58              for each archive in the folio.  The verbose option causes  pmafm
59              to dump the label record from each archive using pmdumplog -l.
60
61              The first named archive in the folio is assumed to be associated
62              with the default host for any tool that tries to replay multiple
63              archives from the folio.
64
65       quit
66              Exit pmafm.
67
68       remove
69              Echo  on  standard  output the sh(1) commands required to remove
70              all of the physical files associated with this archive folio.
71
72       repeat tool [arg ...]
73              Execute the known PCP tool once per selected archive.  For exam‐
74              ple, the command
75                   repeat pmval -t60 kernel.all.load
76              would  run  pmval(1)  once  per  archive, with an appropriate -a
77              argument.
78
79       replay
80              Some archive folios are created by tools (e.g. pmchart(1))  that
81              provide  sufficient  information to allow all of the information
82              in all of the archives of a folio to be replayed.
83
84       [run] tool [arg ...]
85              Execute the known PCP tool on the selected archives.   Some  PCP
86              tools  are  able to process multiple concurrent archives, and in
87              this case the tool is run once with the list of all selected ar‐
88              chives  passed  via  a  -a argument.  Otherwise, this command is
89              synonymous with repeat.
90
91       selections
92              Display those archives that would  be  selected  for  processing
93              with a repeat, replay or run command.
94
95       The  restrictions  via  any hosts and archives commands are conjuncted.
96       These restrictions serve to limit the specific  archives  processed  in
97       the  subsequent  repeat,  replay,  run  and  selections  commands.   By
98       default, all archives are selected.
99
100       Keywords in commands may be abbreviated provided no ambiguity is intro‐
101       duced, e.g.  help, hel and he are synonymous, but h is ambiguous.
102

DIAGNOSTICS

104       Many, but all are intended to be easily understood.
105

FILES

107       $PCP_VAR_DIR/config/pmafm/*
108            control  files  that define the behavior of each PCP tool known to
109            pmafm.  This  information  may  be  customized  or  extended,  see
110            $PCP_VAR_DIR/config/pmafm/pcp  for documentation of the syntax and
111            semantics of these files.
112
113       $HOME/.pcp/pmafm/*
114            User customization of the control files.  All files in this direc‐
115            tory  are  treated  in  the  same  manner  as control files in the
116            $PCP_VAR_DIR/config/pmafm directory.
117

PCP ENVIRONMENT

119       Environment variables with the prefix PCP_ are used to parameterize the
120       file  and  directory names used by PCP.  On each installation, the file
121       /etc/pcp.conf contains the  local  values  for  these  variables.   The
122       $PCP_CONF  variable may be used to specify an alternative configuration
123       file, as described in pcp.conf(5).
124

SEE ALSO

126       mkaf(1),   pmchart(1),   pcp-atop(1),    PMAPI(3),    pmRecordSetup(3),
127       pcp.conf(5) and pcp.env(5).
128
129
130
131Performance Co-Pilot                  PCP                             PMAFM(1)
Impressum