Merge branch 'main' of https://github.com/kmcdonell/pcp

Conflicts:
    qa/1507

Resolved diffs b/n bozo and bozo-vm.

man/man1/indomcachectl.1

@@ -18,7 +18,14 @@
 \f3indomcachectl\f1 \- manage instance domain cache files
 .SH SYNOPSIS
 .B $PCP_BINADM_DIR/indomcachectl
-[\fB\-lw\fR]
+[\fB\-w\fR]
+\fB\-l\fR
+.I indom
+.sp
+.B $PCP_BINADM_DIR/indomcachectl
+[\fB\-w\fR]
+[\fB\-m\fR \fImode\fR]
+[\fB\-g\fR \fIgroup\fR]
 [\fB\-u\fR \fIuser\fR]
 .I indom
 .SH DESCRIPTION
@@ -49,7 +56,7 @@ parameter uses a 2-dotted format to specify the
 .I domain
 and
 .I serial
-fields of the instance domain (or InDom).
+fields of the instance domain number.
 The required values can be reported for a particular metric using the
 .B \-d
 option to
@@ -59,28 +66,46 @@ If the
 .B \-l
 option is specified the contents of the instance domain cache file
 are dumped on
-.IR stderr ,
+.I stdout
 and
 .I indomcachectl
 exits.
 .PP
-Otherwise an empty instance domain cache file will be created, and
-optionally assigned the owner and default group of the user
+Otherwise an empty instance domain cache file will be created.
+The user ownership of the created file is assigned to the uid
+of the caller, but may optionally assigned to the uid of
 .I user
 from the
 .BR passwd (5)
 file if the
 .I \-u
 option is specified.
+The group ownership of the created file is assigned to the gid
+of the caller, else the default gid of the user
+.I user
+if the
+.I \-u
+option is specified, else the gid of
+.I group
+from the
+.BR group (5)
+file if the
+.I \-g
+option is specified.
+.PP
+The instance domain cache file is created with mode 0660 by
+default (some PMDAs use group read-write permission to access
+and update the contents of the file)
+\- if this
+does not suit the
+.B \-m
+option may be used to set the mode to the (octal) value
+.IR mode .
+.PP
 Because the indom cache files are precious to the associated PMDA
 .I indomcachectl
 will not over-write an existing indom cache file.
 .PP
-The instance domain cache file is created with mode 0660 \- if this
-does not suit, callers should run
-.BR chmod (1)
-subsequently.
-.PP
 Operation is usually silent, except for errors (or warnings if the
 .I \-w
 option is used).
@@ -95,7 +120,8 @@ in extreme cases
 .B provided
 the PMDA is not executing.
 .PP
-Here is an example for the InDom 60.17 that is associated with the
+Here is an example for the instance domain number
+60.17 that is associated with the
 network.interface.* metrics.
 .EX
 $ cat /var/lib/pcp/config/pmda/60.17
@@ -105,20 +131,22 @@ $ cat /var/lib/pcp/config/pmda/60.17
 2 1712727825 lo
 .EE
 .PP
-The first line is magic, do not change it.
+The first line is a magic header, do not change it.
 Following that is one line per instance with the instance identifier
 (an integer) in the first field, some magic in the second field
-(do not change) and the external instance name in the third field.
+(do not change this) and the external instance name in the third field.
 .SH SEE ALSO
 .BR PCPIntro (1),
 .BR chmod (1),
 .BR pminfo (1),
 .BR PMAPI (3),
 .BR PMDA (3),
-.BR pmdaCache (3)
+.BR pmdaCache (3),
+.BR group (5)
 and
 .BR passwd (5).
 
 .\" control lines for scripts/man-spell
+.\" +ok+ uid gid chmod
 .\" +ok+ virbr ens sp [from network interfaces]
 .\" +ok+ pmda [from /var/lib/pcp/config/pmda]

man/man1/pcp-python.1

@@ -93,6 +93,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR PCPIntro (1)
 and
 .BR pcp (1).
-
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmconfig.1

@@ -70,5 +70,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pcp.conf (5)
 and
 .BR pcp.env (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmdamounts.1

@@ -138,5 +138,3 @@ as described in
 .BR pcp.conf (5)
 and
 .BR pcp.env (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmdasummary.1

@@ -146,5 +146,3 @@ as described in
 .BR pmcd (1)
 and
 .BR pmie (1).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmdatrivial.1

@@ -138,5 +138,3 @@ as described in
 .BR pmdatxmon (1)
 and
 .BR PMDA (3).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmdiff.1

@@ -191,5 +191,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pcp.conf (5)
 and
 .BR pcp.env (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmerr.1

@@ -63,5 +63,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pcp.conf (5)
 and
 .BR pcp.env (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmhostname.1

@@ -70,5 +70,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pcp.env (5)
 and
 .BR resolver (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmie_dump_stats.1

@@ -44,5 +44,3 @@ script.
 .BR pmie (1)
 and
 .BR pmiectl (1).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmiestatus.1

@@ -49,5 +49,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pcp.conf (5)
 and
 .BR pcp.env (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmlock.1

@@ -35,5 +35,3 @@ In the event of a failure, the
 .B \-v
 option produces an explanatory message on
 .IR stdout .
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmlogger_merge.1

@@ -94,5 +94,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pmlogger (1)
 and
 .BR pmlogger_daily (1).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmlogger_rewrite.1

@@ -107,5 +107,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pmlogger_daily (1)
 and
 .BR pmlogrewrite (1).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmlogpaste.1

@@ -95,5 +95,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pmlogextract (1)
 and
 .BR LOGIMPORT (3).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmlogreduce.1

@@ -308,5 +308,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pcp.conf (5)
 and
 .BR pcp.env (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmlogsize.1

@@ -100,5 +100,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pmlogdump (1)
 and
 .BR pmlogger (1).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmnsdel.1

@@ -102,5 +102,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR pcp.env (5)
 and
 .BR PMNS (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmpost.1

@@ -75,5 +75,3 @@ contains the local values for PCP_ variables.
 .BR pcp.conf (5)
 and
 .BR pcp.env (5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/pmtime.1

@@ -85,5 +85,3 @@ The default starting port number is \fB43334\fP.
 .BR pmstat (1)
 and
 .BR pmval (1).
-
-.\" control lines not needed for scripts/man-spell

man/man1/runaspcp.1

@@ -63,5 +63,3 @@ On each installation, the
 file \fI/etc/pcp.conf\fP contains the local values for these variables.
 The \fB$PCP_CONF\fP variable may be used to specify an alternative
 configuration file, as described in \fBpcp.conf\fP(5).
-
-.\" control lines not needed for scripts/man-spell

man/man1/telnet-probe.1

@@ -93,5 +93,3 @@ configuration file, as described in \fBpcp.conf\fP(5).
 .BR read (2)
 and
 .BR write (2).
-
-.\" control lines not needed for scripts/man-spell

man/man3/QmcIndom.3

@@ -39,7 +39,7 @@ NULL entry in the instance table.
 
 - external name
 
-- reference count, ie. the number of
+- reference count, i.e. the number of
 .B QmcMetric
 objects referring to this instance.
 

man/man3/logimport.3

@@ -67,7 +67,7 @@ Optional calls to
 .BR pmiGetHandle (3)
 to defined convenience handles for metric-instance pairs.
 .IP \(bu 3n
-A main loop in which performance data is injested and for each
+A main loop in which performance data is ingested and for each
 sample time interval, the PCP archive record is constructed by calls
 to
 .BR pmiPutValue (3),
@@ -101,19 +101,26 @@ that references those metrics and instances.
 .SH SEE ALSO
 .BR pmcd (1),
 .BR pmlogger (1),
-.BR pmiGetHandle (3),
+.BR PMAPI (3),
 .BR pmiAddInstance (3),
 .BR pmiAddMetric (3),
 .BR pmiEnd (3),
 .BR pmiErrStr (3),
+.BR pmiGetHandle (3),
+.BR pmiPutLabel (3),
 .BR pmiPutMark (3),
 .BR pmiPutResult (3),
+.BR pmiPutText (3),
 .BR pmiPutValue (3),
 .BR pmiPutValueHandle (3),
-.BR pmiPutText (3),
-.BR pmiPutLabel (3),
 .BR pmiSetHostname (3),
 .BR pmiSetTimezone (3),
 .BR pmiStart (3)
 and
 .BR pmiWrite (3).
+
+.\" control lines for scripts/man-spell
+.\" +ok+ pmiPutValueHandle pmiAddInstance pmiSetHostname pmiSetTimezone
+.\" +ok+ pmiGetHandle pmiPutResult pmiPutLabel pmiPutValue
+.\" +ok+ pmiPutMark pmiPutText pmiErrStr injestion pmiStart pmiWrite
+.\" +ok+ pmiEnd pmi [from ... import pmi]

man/man3/mmv_inc_value.3

@@ -63,3 +63,7 @@ the metric and then added to the previous value of the metric.
 .BR mmv_lookup_value_desc (3)
 and
 .BR mmv (5).
+
+.\" control lines for scripts/man-spell
+.\" +ok+ mmv_lookup_value_desc mmv_inc_atomvalue mmv_stats_init mmv_inc_value
+.\" +ok+ mmv_set_value mmv_inc mmv

man/man3/mmv_lookup_value_desc.3

@@ -66,3 +66,7 @@ on success or NULL on failure.
 .BR mmv_inc_value (3)
 and
 .BR mmv (5).
+
+.\" control lines for scripts/man-spell
+.\" +ok+ mmv_lookup_value_desc mmv_set_string mmv_set_strlen mmv_stats_init
+.\" +ok+ mmv_inc_value pmValueBlock __uint __int MMV vbp ull mmv ptr ll ul _t

man/man3/mmv_set_value.3

@@ -51,7 +51,7 @@ Refer to
 for a mechanism suited to monotonic increasing counter metrics.
 .P
 With \f3mmv_set\f1 and
-\f3mmv_set_atomvalue\f1 the value provided via the \f2inc\f1
+\f3mmv_set_atomvalue\f1 the value provided via the \f2val\f1
 pointer must match the type of the metric and will be used as
 the new value of the metric.
 .P

man/man3/mmv_stats_init.3

@@ -159,3 +159,9 @@ for decoding with
 .BR strerror (3)
 and
 .BR mmv (5).
+
+.\" control lines for scripts/man-spell
+.\" +ok+ mmv_metric_type_t mmv_stats_flags_t MMV_FLAG_PROCESS mmv_metric_sem_t
+.\" +ok+ mmv_instances_t mmv_instances mmv_metric_t mmv_indom_t MMV_NAMEMAX
+.\" +ok+ mmv_metric shorttext mmv_indom mmv_stats helptext strerror
+.\" +ok+ _init [from mmv_stats2_init] IDs MMV

man/man3/mmv_stats_registry.3

@@ -68,7 +68,7 @@ handle returned by an earlier initialization call and also frees
 the registry structure.
 .P
 The combination of \f3mmv_stats_registry\f1 and \f3mmv_stats_start\f1
-do the same as the deprecated calls \f3mmv_stats(2)_init\f1.
+do the same as the deprecated calls \f3mmv_stats2_init\f1.
 However, now, one should first call \f3mmv_stats_registry\f1 and then
 the API calls that add instances, indoms, metrics and labels.
 In this way, there is no need to know in advance which version of the
@@ -215,3 +215,11 @@ for decoding with
 .BR strerror (3)
 and
 .BR mmv (5).
+
+.\" control lines for scripts/man-spell
+.\" +ok+ mmv_metric_type_t mmv_stats_flags_t MMV_BOOLEAN_TYPE MMV_FLAG_PROCESS
+.\" +ok+ mmv_metric_sem_t mmv_value_type_t MMV_NUMBER_TYPE MMV_STRING_TYPE
+.\" +ok+ MMV_ARRAY_TYPE mmv_registry_t mmv_instances MMV_NULL_TYPE
+.\" +ok+ MMV_MAP_TYPE mmv_metric shorthelp shorttext mmv_indom mmv_stats
+.\" +ok+ helptext instname longhelp INDOMS instid
+.\" +ok+ _init [from mmv_stats2_init] IDs sem MMV

man/man3/pcpintro.3

@@ -96,7 +96,7 @@ to indicate these situations.
 .I "IPC protocol failure"
 .br
 Generic protocol failure
-on a pipe or socket connecting two PCP applications, eg. client\-\c
+on a pipe or socket connecting two PCP applications, e.g. client\-\c
 .BR pmcd ,
 or client\-\c
 .BR pmtime ,
@@ -117,7 +117,7 @@ requested metric or instance domain help text.
 .br
 This error is used for a number of conditions in which the value
 of a performance metric is inappropriate for the context in
-which it is being used, eg.
+which it is being used, e.g.
 .RS
 .IP (a) 4n
 Bad value for the metric
@@ -166,7 +166,7 @@ to a PMDA.
 .B PM_ERR_EOF
 .I "IPC channel closed"
 .br
-End of file on a pipe or socket connecting two PCP applications, eg. client\-\c
+End of file on a pipe or socket connecting two PCP applications, e.g. client\-\c
 .BR pmcd ,
 or client\-\c
 .B pmtime
@@ -195,7 +195,7 @@ Platform-specific permission errors are returned as
 .B PM_ERR_CONV
 .I "Impossible value or scale conversion"
 .br
-Some value conversion requests are illegal, eg. bad debug flag symbolic name
+Some value conversion requests are illegal, e.g. bad debug flag symbolic name
 for
 .B \-D/\-\-debug
 option, or asking

man/man3/pmaddderived.3

@@ -53,7 +53,7 @@ are created with the associated
 .BR pmRegisterDerived (3),
 .BR pmRegisterDerivedMetric (3)
 and
-.BR pmRegisterLoadConfig (3)
+.BR pmLoadDerivedConfig (3)
 routines.
 .PP
 The arguments to

man/man3/pmapi.3

@@ -432,3 +432,6 @@ function.
 .BR pcp.env (5)
 and
 .BR PMNS (5).
+
+.\" control lines for scripts/man-spell
+.\" +ok+ ds [from troff .ds]