From c76f48074351160c69d2d049d826151236fb17c2 Mon Sep 17 00:00:00 2001 From: Dan McDonald Date: Tue, 15 Mar 2022 12:07:24 -0400 Subject: [PATCH] OS-8361 IPD 4 (man page renumbering) tracking issue Reviewed by: Brian Bennett Approved by: Brian Bennett --- man/Makefile | 44 +++++++++---------- man/mancheck.conf | 2 +- man/manifest | 40 ++++++++--------- man/smartdc/man/man1/sdc-lastcomm.1 | 2 +- .../man/{man5/joyent.5 => man7/joyent.7} | 10 ++--- .../man/{man5/openssl.5 => man7/openssl.7} | 10 ++--- .../disklayout.1m.md => man8/disklayout.8.md} | 14 +++--- .../man/{man1m/fssstat.1m => man8/fssstat.8} | 4 +- .../fwadm.1m.md.in => man8/fwadm.8.md.in} | 24 +++++----- .../man/{man1m/mkzpool.1m => man8/mkzpool.8} | 12 ++--- .../nictagadm.1m.md => man8/nictagadm.8.md} | 6 +-- .../{man1m/piadm.1m.md => man8/piadm.8.md} | 40 ++++++++--------- .../sysevent.1m.md => man8/sysevent.8.md} | 4 +- .../sysinfo.1m.md => man8/sysinfo.8.md} | 4 +- .../{man1m/vminfo.1m.md => man8/vminfo.8.md} | 6 +-- .../ziostat.1m.md => man8/ziostat.8.md} | 6 +-- .../zonememstat.1m => man8/zonememstat.8} | 4 +- .../man/{man1m/zonemon.1m => man8/zonemon.8} | 2 +- src/dockerinit/mdata-client/Makefile | 4 +- src/dockerinit/mdata-client/README.md | 16 +++---- .../mdata-delete.1m => man8/mdata-delete.8} | 0 .../{man1m/mdata-get.1m => man8/mdata-get.8} | 0 .../mdata-list.1m => man8/mdata-list.8} | 0 .../{man1m/mdata-put.1m => man8/mdata-put.8} | 0 src/dockerinit/mdata-client/manifest | 8 ++-- src/fw/Makefile | 18 ++++---- src/fw/lib/fw.js | 8 ++-- src/fw/lib/ipf.js | 8 ++-- src/fw/man/{fwadm.1m.md => fwadm.8.md} | 24 +++++----- src/fw/man/fwrule.5.footer | 4 -- src/fw/man/fwrule.5.header | 3 -- src/fw/man/fwrule.7.footer | 4 ++ src/fw/man/fwrule.7.header | 3 ++ src/fw/man/{fwrule.5.md => fwrule.7.md} | 4 +- src/fw/package.json | 2 +- src/fw/test/integration/examples.test.js | 2 +- .../test/integration/in-zone-enabled.test.js | 2 +- src/fw/test/integration/ipsec.test.js | 2 +- src/fw/test/lib/fw.js | 2 +- src/fw/test/lib/vm.js | 2 +- src/img/Makefile | 2 +- src/img/lib/cli.js | 2 +- src/img/man/{imgadm.1m.md => imgadm.8.md} | 4 +- src/img/tools/dev-install | 10 ++--- src/lib/sdc/usb-key.sh | 8 ++-- src/nictagadm | 2 +- src/node-dtrace-provider/README.md | 2 +- src/piadm.sh | 4 +- src/routeinfo/main.c | 6 +-- src/smartdc/lib/smartos_prompt_config.sh | 6 +-- src/vm/man/{vmadm.1m.md => vmadm.8.md} | 22 +++++----- src/vm/man/{vmadmd.1m.md => vmadmd.8.md} | 18 ++++---- src/vm/node_modules/VM.js | 4 +- src/vm/node_modules/sysevent-stream.js | 12 ++--- src/vm/node_modules/vminfod/vminfod.js | 2 +- src/vm/node_modules/vmload/vmload-datasets.js | 4 +- src/vm/node_modules/zonecfg.js | 4 +- src/vm/sbin/vmadm.js | 4 +- .../testdata/vmload-xml/bhyve-disk-sort.xml | 2 +- .../c673ec7c-aca9-4a4c-a4be-52fa82b2f0cd.xml | 2 +- .../testdata/vmload-xml/kvm-disk-sort.xml | 2 +- src/vm/tests/testdata/vmload-xml/lx.xml | 2 +- .../testdata/vmload-xml/maximal-joyent.xml | 2 +- .../testdata/vmload-xml/minimal-joyent.xml | 2 +- tools/format_image/format_image.c | 4 +- tools/mancf/main.c | 2 +- tools/mancheck/README.md | 8 ++-- tools/mancheck/main.c | 11 ++--- 68 files changed, 252 insertions(+), 251 deletions(-) rename man/usr/share/man/{man5/joyent.5 => man7/joyent.7} (74%) rename man/usr/share/man/{man5/openssl.5 => man7/openssl.7} (88%) rename man/usr/share/man/{man1m/disklayout.1m.md => man8/disklayout.8.md} (91%) rename man/usr/share/man/{man1m/fssstat.1m => man8/fssstat.8} (92%) rename man/usr/share/man/{man1m/fwadm.1m.md.in => man8/fwadm.8.md.in} (95%) rename man/usr/share/man/{man1m/mkzpool.1m => man8/mkzpool.8} (89%) rename man/usr/share/man/{man1m/nictagadm.1m.md => man8/nictagadm.8.md} (96%) rename man/usr/share/man/{man1m/piadm.1m.md => man8/piadm.8.md} (92%) rename man/usr/share/man/{man1m/sysevent.1m.md => man8/sysevent.8.md} (93%) rename man/usr/share/man/{man1m/sysinfo.1m.md => man8/sysinfo.8.md} (97%) rename man/usr/share/man/{man1m/vminfo.1m.md => man8/vminfo.8.md} (86%) rename man/usr/share/man/{man1m/ziostat.1m.md => man8/ziostat.8.md} (92%) rename man/usr/share/man/{man1m/zonememstat.1m => man8/zonememstat.8} (94%) rename man/usr/share/man/{man1m/zonemon.1m => man8/zonemon.8} (96%) rename src/dockerinit/mdata-client/man/{man1m/mdata-delete.1m => man8/mdata-delete.8} (100%) rename src/dockerinit/mdata-client/man/{man1m/mdata-get.1m => man8/mdata-get.8} (100%) rename src/dockerinit/mdata-client/man/{man1m/mdata-list.1m => man8/mdata-list.8} (100%) rename src/dockerinit/mdata-client/man/{man1m/mdata-put.1m => man8/mdata-put.8} (100%) rename src/fw/man/{fwadm.1m.md => fwadm.8.md} (96%) delete mode 100644 src/fw/man/fwrule.5.footer delete mode 100644 src/fw/man/fwrule.5.header create mode 100644 src/fw/man/fwrule.7.footer create mode 100644 src/fw/man/fwrule.7.header rename src/fw/man/{fwrule.5.md => fwrule.7.md} (98%) rename src/img/man/{imgadm.1m.md => imgadm.8.md} (99%) rename src/vm/man/{vmadm.1m.md => vmadm.8.md} (99%) rename src/vm/man/{vmadmd.1m.md => vmadmd.8.md} (93%) diff --git a/man/Makefile b/man/Makefile index 7dcd32ee..1175c49e 100644 --- a/man/Makefile +++ b/man/Makefile @@ -22,24 +22,24 @@ MAN_FILES = \ usr/share/man/man1/gzegrep.1 \ usr/share/man/man1/gzfgrep.1 \ usr/share/man/man1/json.1 \ - usr/share/man/man1m/disklayout.1m \ - usr/share/man/man1m/fssstat.1m \ - usr/share/man/man1m/fwadm.1m \ - usr/share/man/man1m/imgadm.1m \ - usr/share/man/man1m/mkzpool.1m \ - usr/share/man/man1m/nictagadm.1m \ - usr/share/man/man1m/piadm.1m \ - usr/share/man/man1m/sysevent.1m \ - usr/share/man/man1m/sysinfo.1m \ - usr/share/man/man1m/vmadm.1m \ - usr/share/man/man1m/vmadmd.1m \ - usr/share/man/man1m/vminfo.1m \ - usr/share/man/man1m/ziostat.1m \ - usr/share/man/man1m/zonememstat.1m \ - usr/share/man/man1m/zonemon.1m \ - usr/share/man/man5/fwrule.5 \ - usr/share/man/man5/joyent.5 \ - usr/share/man/man5/openssl.5 + usr/share/man/man7/fwrule.7 \ + usr/share/man/man7/joyent.7 \ + usr/share/man/man7/openssl.7 \ + usr/share/man/man8/disklayout.8 \ + usr/share/man/man8/fssstat.8 \ + usr/share/man/man8/fwadm.8 \ + usr/share/man/man8/imgadm.8 \ + usr/share/man/man8/mkzpool.8 \ + usr/share/man/man8/nictagadm.8 \ + usr/share/man/man8/piadm.8 \ + usr/share/man/man8/sysevent.8 \ + usr/share/man/man8/sysinfo.8 \ + usr/share/man/man8/vmadm.8 \ + usr/share/man/man8/vmadmd.8 \ + usr/share/man/man8/vminfo.8 \ + usr/share/man/man8/ziostat.8 \ + usr/share/man/man8/zonememstat.8 \ + usr/share/man/man8/zonemon.8 PROTO_FILES = $(MAN_FILES:%=$(DESTDIR)/%) @@ -60,22 +60,22 @@ $(DESTDIR)/%: %.md rm -f $@ $(RONNJS) --roff $< > $@ -$(DESTDIR)/usr/share/man/man1m/%: $(ROOT)/src/fw/man/%.md +$(DESTDIR)/usr/share/man/man8/%: $(ROOT)/src/fw/man/%.md mkdir -p $(@D) rm -f $@ $(RONNJS) --roff $< > $@ -$(DESTDIR)/usr/share/man/man5/%: $(ROOT)/src/fw/man/%.md +$(DESTDIR)/usr/share/man/man7/%: $(ROOT)/src/fw/man/%.md mkdir -p $(@D) rm -f $@ $(RONNJS) --roff $< > $@ -$(DESTDIR)/usr/share/man/man1m/%: $(ROOT)/src/img/man/%.md +$(DESTDIR)/usr/share/man/man8/%: $(ROOT)/src/img/man/%.md mkdir -p $(@D) rm -f $@ $(RONNJS) --roff $< > $@ -$(DESTDIR)/usr/share/man/man1m/%: $(ROOT)/src/vm/man/%.md +$(DESTDIR)/usr/share/man/man8/%: $(ROOT)/src/vm/man/%.md mkdir -p $(@D) rm -f $@ $(RONNJS) --roff $< > $@ diff --git a/man/mancheck.conf b/man/mancheck.conf index 58ff5270..8aa14470 100644 --- a/man/mancheck.conf +++ b/man/mancheck.conf @@ -14,4 +14,4 @@ * guidance. */ -+section "5"; ++section "7"; diff --git a/man/manifest b/man/manifest index 6e5ea03e..9e3bbbe0 100644 --- a/man/manifest +++ b/man/manifest @@ -1,29 +1,29 @@ d smartdc/man 0555 root bin d smartdc/man/man1 0555 root bin d usr/share/man/man1 0755 root bin -d usr/share/man/man1m 0755 root bin d usr/share/man/man3lib 0755 root bin -d usr/share/man/man5 0755 root bin +d usr/share/man/man7 0755 root bin +d usr/share/man/man8 0755 root bin f smartdc/man/man1/sdc-factoryreset.1 0444 root bin f smartdc/man/man1/sdc-lastcomm.1 0444 root bin f smartdc/man/man1/sdc-zfs-io-throttle.1 0444 root bin f usr/share/man/man.cf 0444 root bin f usr/share/man/man1/json.1 0444 root bin -f usr/share/man/man1m/disklayout.1m 0444 root bin -f usr/share/man/man1m/fssstat.1m 0444 root bin -f usr/share/man/man1m/fwadm.1m 0444 root bin -f usr/share/man/man1m/imgadm.1m 0444 root bin -f usr/share/man/man1m/mkzpool.1m 0444 root bin -f usr/share/man/man1m/nictagadm.1m 0444 root bin -f usr/share/man/man1m/piadm.1m 0444 root bin -f usr/share/man/man1m/sysevent.1m 0444 root bin -f usr/share/man/man1m/sysinfo.1m 0444 root bin -f usr/share/man/man1m/vmadm.1m 0444 root bin -f usr/share/man/man1m/vmadmd.1m 0444 root bin -f usr/share/man/man1m/vminfo.1m 0444 root bin -f usr/share/man/man1m/ziostat.1m 0444 root bin -f usr/share/man/man1m/zonememstat.1m 0444 root bin -f usr/share/man/man1m/zonemon.1m 0444 root bin -f usr/share/man/man5/fwrule.5 0444 root bin -f usr/share/man/man5/joyent.5 0444 root bin -f usr/share/man/man5/openssl.5 0444 root bin +f usr/share/man/man7/fwrule.7 0444 root bin +f usr/share/man/man7/joyent.7 0444 root bin +f usr/share/man/man7/openssl.7 0444 root bin +f usr/share/man/man8/disklayout.8 0444 root bin +f usr/share/man/man8/fssstat.8 0444 root bin +f usr/share/man/man8/fwadm.8 0444 root bin +f usr/share/man/man8/imgadm.8 0444 root bin +f usr/share/man/man8/mkzpool.8 0444 root bin +f usr/share/man/man8/nictagadm.8 0444 root bin +f usr/share/man/man8/piadm.8 0444 root bin +f usr/share/man/man8/sysevent.8 0444 root bin +f usr/share/man/man8/sysinfo.8 0444 root bin +f usr/share/man/man8/vmadm.8 0444 root bin +f usr/share/man/man8/vmadmd.8 0444 root bin +f usr/share/man/man8/vminfo.8 0444 root bin +f usr/share/man/man8/ziostat.8 0444 root bin +f usr/share/man/man8/zonememstat.8 0444 root bin +f usr/share/man/man8/zonemon.8 0444 root bin diff --git a/man/smartdc/man/man1/sdc-lastcomm.1 b/man/smartdc/man/man1/sdc-lastcomm.1 index cffd9ceb..80b9d17b 100644 --- a/man/smartdc/man/man1/sdc-lastcomm.1 +++ b/man/smartdc/man/man1/sdc-lastcomm.1 @@ -103,4 +103,4 @@ sdc\-lastcomm Copyright (c) 2012, Joyent Inc\., All rights reserved\. .SH SEE ALSO .sp .LP -\fBlastcomm\fR(1), \fBpraudit\fR(1M) +\fBlastcomm\fR(1), \fBpraudit\fR(8) diff --git a/man/usr/share/man/man5/joyent.5 b/man/usr/share/man/man7/joyent.7 similarity index 74% rename from man/usr/share/man/man5/joyent.5 rename to man/usr/share/man/man7/joyent.7 index 0277ff82..43290c4d 100644 --- a/man/usr/share/man/man5/joyent.5 +++ b/man/usr/share/man/man7/joyent.7 @@ -3,13 +3,13 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH joyent 5 "8 Mar 2011" "SunOS 5.11" "Standards, Environments, and Macros" +.TH joyent 7 "8 Mar 2011" "SunOS 5.11" "Standards, Environments, and Macros" .SH NAME joyent \- Joyent branded zone .SH DESCRIPTION .sp .LP -The \fBjoyent\fR brand uses the branded zones framework described in \fBbrands\fR(5) to implement Joyent SmartMachines. +The \fBjoyent\fR brand uses the branded zones framework described in \fBbrands\fR(7) to implement Joyent SmartMachines. .sp .LP .SS "Configuration and Administration" @@ -34,12 +34,12 @@ Blocks network traffic on the specified list of ports. .sp .LP -The \fBzonecfg\fR(1M) utility is used to configure an \fBjoyent\fR branded zone. Once a branded zone has been installed, that zone's brand cannot be changed or removed. The \fBzoneadm\fR(1M) utility is used to report the zone's brand type and administer the zone. The \fBzlogin\fR(1) utility is used to log in to the zone. +The \fBzonecfg\fR(8) utility is used to configure an \fBjoyent\fR branded zone. Once a branded zone has been installed, that zone's brand cannot be changed or removed. The \fBzoneadm\fR(8) utility is used to report the zone's brand type and administer the zone. The \fBzlogin\fR(1) utility is used to log in to the zone. .SH ATTRIBUTES .sp .LP -See \fBattributes\fR(5) for a description of the following attributes: +See \fBattributes\fR(7) for a description of the following attributes: .sp .sp @@ -54,4 +54,4 @@ Interface StabilityEvolving .SH SEE ALSO .sp .LP -\fBmdb\fR(1), \fBzlogin\fR(1), \fBzonename\fR(1), \fBdtrace\fR(1M), \fBzoneadm\fR(1M), \fBzonecfg\fR(1M), \fBbrands\fR(5), \fBzones\fR(5) +\fBmdb\fR(1), \fBzlogin\fR(1), \fBzonename\fR(1), \fBbrands\fR(7), \fBzones\fR(7), \fBdtrace\fR(8), \fBzoneadm\fR(8), \fBzonecfg\fR(8) diff --git a/man/usr/share/man/man5/openssl.5 b/man/usr/share/man/man7/openssl.7 similarity index 88% rename from man/usr/share/man/man5/openssl.5 rename to man/usr/share/man/man7/openssl.7 index 8abbf3a1..d1819873 100644 --- a/man/usr/share/man/man5/openssl.5 +++ b/man/usr/share/man/man7/openssl.7 @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH openssl 5 "1 Aug 2008" "SunOS 5.11" "Standards, Environments, and Macros" +.TH openssl 7 "1 Aug 2008" "SunOS 5.11" "Standards, Environments, and Macros" .SH NAME openssl \- OpenSSL cryptographic and Secure Sockets Layer toolkit .SH DESCRIPTION @@ -18,7 +18,7 @@ The following features are omitted from the binaries for issues including but no A new PKCS#11 engine has been included with ENGINE name "pkcs11". The engine was developed in Sun and is not integrated in the OpenSSL project. .sp .LP -The PKCS#11 engine is configured to use the Solaris Cryptographic Framework. See \fBcryptoadm\fR(1M) for configuration information. +The PKCS#11 engine is configured to use the Solaris Cryptographic Framework. See \fBcryptoadm\fR(8) for configuration information. .sp .LP The PKCS#11 engine can support the following set of mechanisms: CKM_AES_CBC, CKM_AES_ECB, CKM_BLOWFISH_CBC, CKM_DES_CBC, CKM_DES_ECB, CKM_DES3_CBC, CKM_DES3_ECB, CKM_DSA, CKM_MD5, CKM_RC4, CKM_RSA_PKCS, CKM_RSA_X_509, CKM_SHA_1, CKM_SHA224, CKM_SHA256, CKM_SHA384, and CKM_SHA512. @@ -44,14 +44,14 @@ to avoid library symbol conflicts. .sp .LP -Extensive additional documentation for OpenSSL modules is available in the \fB/usr/share/man/man1openssl\fR, \fB/usr/share/man/man3openssl\fR, \fB/usr/share/man/man5openssl\fR, and \fB/usr/share/man/man7openssl\fR directories. +Extensive additional documentation for OpenSSL modules is available in the \fB/usr/share/man/man1/openssl\fR, \fB/usr/share/man/man3/openssl\fR, \fB/usr/share/man/man5/openssl\fR, and \fB/usr/share/man/man7/openssl\fR directories. .sp .LP To view the license terms, attribution, and copyright for OpenSSL, see \fB/var/sadm/pkg/SUNWopensslr/install/copyright\fR. .SH ATTRIBUTES .sp .LP -See \fBattributes\fR(5) for a description of the following attributes: +See \fBattributes\fR(7) for a description of the following attributes: .sp .sp @@ -70,7 +70,7 @@ Interface StabilityExternal .SH SEE ALSO .sp .LP -\fBcryptoadm\fR(1M), \fBlibpkcs11\fR(3LIB), \fBattributes\fR(5) +\fBlibpkcs11\fR(3LIB), \fBattributes\fR(7), \fBcryptoadm\fR(8) .sp .LP \fB/usr/share/man/man1openssl/openssl.1openssl\fR, \fB/usr/sfw/man/man3/engine.3\fR, \fB/usr/sfw/man/man3/evp.3\fR diff --git a/man/usr/share/man/man1m/disklayout.1m.md b/man/usr/share/man/man8/disklayout.8.md similarity index 91% rename from man/usr/share/man/man1m/disklayout.1m.md rename to man/usr/share/man/man8/disklayout.8.md index a752e349..9e3775d2 100644 --- a/man/usr/share/man/man1m/disklayout.1m.md +++ b/man/usr/share/man/man8/disklayout.8.md @@ -1,4 +1,4 @@ -# disklayout(1m) -- Lay out a ZFS pool configuration from a disk inventory +# disklayout(8) -- Lay out a ZFS pool configuration from a disk inventory ## SYNOPSIS @@ -8,9 +8,9 @@ ## DESCRIPTION disklayout generates a JSON description of a ZFS pool configuration -suitable for use by the mkzpool(1M) utility. The utility may be run in +suitable for use by the mkzpool(8) utility. The utility may be run in two modes; when the **-f** option is given, the specified file is taken -to be the output of the diskinfo(1M) command and used as the source of +to be the output of the diskinfo(8) command and used as the source of information about the available disks. Otherwise, the disks currently present on the system will be enumerated and the utility will attempt to generate a pool layout that uses as many of the available disks as @@ -124,7 +124,7 @@ A vdev specification contains the following properties: "type" -The vdev type, as defined by ZFS. See zpool(1M). +The vdev type, as defined by ZFS. See zpool(8). "devices" @@ -140,11 +140,11 @@ The base name of the device's nodes under /dev/dsk. "vid" -The vendor identification string of the device. See diskinfo(1M). +The vendor identification string of the device. See diskinfo(8). "pid" -The product identification string of the device. See diskinfo(1M). +The product identification string of the device. See diskinfo(8). "size" @@ -160,4 +160,4 @@ description of the error. This message is not localised. ## SEE ALSO - diskinfo(1M), mkzpool(1M), sd(7D), zpool(1M) + diskinfo(8), mkzpool(8), sd(7D), zpool(8) diff --git a/man/usr/share/man/man1m/fssstat.1m b/man/usr/share/man/man8/fssstat.8 similarity index 92% rename from man/usr/share/man/man1m/fssstat.1m rename to man/usr/share/man/man8/fssstat.8 index 93fcadb2..f355305d 100644 --- a/man/usr/share/man/man1m/fssstat.1m +++ b/man/usr/share/man/man8/fssstat.8 @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH fssstat 1M "10 Sep 2012" "SunOS 5.11" "System Administration Commands" +.TH fssstat 8 "10 Sep 2012" "SunOS 5.11" "System Administration Commands" .SH NAME fssstat \- display internal FSS statistics .SH SYNOPSIS @@ -15,7 +15,7 @@ fssstat \- display internal FSS statistics .SH DESCRIPTION .sp .LP -The \fBfssstat\fR command prints a summary of per-runnable process \fBFSS(7)\fR +The \fBfssstat\fR command prints a summary of per-runnable process \fBFSS(4)\fR scheduling statistics every second. An optional count, specifying the number of iterations, can be provided. This data is primarily used to diagnose FSS. .sp diff --git a/man/usr/share/man/man1m/fwadm.1m.md.in b/man/usr/share/man/man8/fwadm.8.md.in similarity index 95% rename from man/usr/share/man/man1m/fwadm.1m.md.in rename to man/usr/share/man/man8/fwadm.8.md.in index ee2c07ec..58e02137 100644 --- a/man/usr/share/man/man1m/fwadm.1m.md.in +++ b/man/usr/share/man/man8/fwadm.8.md.in @@ -1,4 +1,4 @@ -# fwadm(1M) -- Manage SmartOS firewall rules +# fwadm(8) -- Manage SmartOS firewall rules ## SYNOPSIS @@ -35,11 +35,11 @@ The fwadm tool allows you to manage firewall data on a SmartOS system. It is primarily used to manage firewall rules and remote VMs. Firewall rules are JSON objects. They contain a rule written in a -Domain-Specific Language, as well as other metadata. See fwrule(5) and +Domain-Specific Language, as well as other metadata. See fwrule(7) and the "EXAMPLES" section below for rule syntax. Remote VMs are JSON objects. They represent VMs on other SmartOS hosts. -The format is similar to the vmadm(1M) format with most properties omitted +The format is similar to the vmadm(8) format with most properties omitted and some simplified properties. See the "REMOTE VMS", "REMOTE VM PROPERTIES" and "EXAMPLES" sections below for details. @@ -96,7 +96,7 @@ the firewalls of any VMs affected. Arguments: Firewall rule, written in the rule DSL. See - fwrule(5) for syntax. + fwrule(7) for syntax. Examples: {{#indent_and_wrap}} @@ -214,7 +214,7 @@ the firewalls of any VMs affected. Arguments: Firewall rule, written in the rule DSL. - See fwrule(5) for syntax. + See fwrule(7) for syntax. Examples: {{#indent_and_wrap}} @@ -338,7 +338,7 @@ the firewalls of any VMs affected. ## REMOTE VM PROPERTIES - Remote VMs are simplified versions of the VM objects used by vmadm(1M). + Remote VMs are simplified versions of the VM objects used by vmadm(8). They are also in a JSON format, but only the properties below will be stored and used by fwadm. All other properties will be discarded. The properties used are: @@ -351,7 +351,7 @@ the firewalls of any VMs affected. nics: - Array of nics, as per vmadm(1M). Only the "ip" property of each of + Array of nics, as per vmadm(8). Only the "ip" property of each of these nic objects is required - all other properties will be ignored. This property is used for creation of remote VMs only - it is not stored in the object. IPs from these objects will be added to the ips @@ -365,12 +365,12 @@ the firewalls of any VMs affected. tags: - vmadm(1M) tags object, mapping tag keys to values. + vmadm(8) tags object, mapping tag keys to values. uuid (required): UUID. This must not be the same as the UUID of any other remote VM or - local VM managed by vmadm(1M). + local VM managed by vmadm(8). Note that VMs can be added and updated in this simplified representation, or using the same representation as "vmadm get". This enables the output @@ -378,9 +378,9 @@ the firewalls of any VMs affected. "SUBCOMMANDS" section. -## INTERACTION WITH VMADM(1M) +## INTERACTION WITH VMADM(8) - fwadm relies on properties of VMs from vmadm(1M) in order to generate + fwadm relies on properties of VMs from vmadm(8) in order to generate firewall rules correctly. Therefore, when vmadm is used to create a new VM or update properties on an existing VM that can affect firewall rules, it will update firewall rules through fwadm accordingly. @@ -421,4 +421,4 @@ The following exit values are returned: ## SEE ALSO - vmadm(1M), fwrule(5), ipf(1M), ipfilter(5) + fwrule(7), ipfilter(7), ipf(8), vmadm(8) diff --git a/man/usr/share/man/man1m/mkzpool.1m b/man/usr/share/man/man8/mkzpool.8 similarity index 89% rename from man/usr/share/man/man1m/mkzpool.1m rename to man/usr/share/man/man8/mkzpool.8 index f1cd172f..9ac0c813 100644 --- a/man/usr/share/man/man1m/mkzpool.1m +++ b/man/usr/share/man/man8/mkzpool.8 @@ -1,5 +1,5 @@ .Dd February 26, 2020 -.Dt MKZPOOL 1M +.Dt MKZPOOL 8 .Os .Sh NAME .Nm mkzpool @@ -12,14 +12,14 @@ .Sh DESCRIPTION .Nm functions as a wrapper around -.Xr zpool 1M . +.Xr zpool 8 . It creates a pool named .Ar pool from a JSON specification in the file named .Ar file.json instead of command\-line arguments. The input JSON must satisfy the schema described in the -.Xr disklayout 1M +.Xr disklayout 8 output specification. .Ss OPTIONS .Bl -tag -width Fl @@ -34,8 +34,8 @@ This flag has the same meaning as the same flag when passed to .El .Sh WARNINGS Use of this command is subject to the same caveats and warnings as the -.Xr zpool 1M +.Xr zpool 8 create command. .Sh "SEE ALSO" -.Xr disklayout 1M , -.Xr zpool 1M +.Xr disklayout 8 , +.Xr zpool 8 diff --git a/man/usr/share/man/man1m/nictagadm.1m.md b/man/usr/share/man/man8/nictagadm.8.md similarity index 96% rename from man/usr/share/man/man1m/nictagadm.1m.md rename to man/usr/share/man/man8/nictagadm.8.md index 279f9752..e0a4cdf2 100644 --- a/man/usr/share/man/man1m/nictagadm.1m.md +++ b/man/usr/share/man/man8/nictagadm.8.md @@ -1,4 +1,4 @@ -# nictagadm(1M) -- Manage SmartOS nic tags. +# nictagadm(8) -- Manage SmartOS nic tags. ## SYNOPSIS @@ -19,7 +19,7 @@ about SmartOS nic tags. Both standard nic tags and local-only etherstubs can be managed. Nic tags are used in SmartOS to refer to a physical nic without needing its -underlying MAC address or interface name. Both vmadm(1M) and the SmartOS +underlying MAC address or interface name. Both vmadm(8) and the SmartOS config file use them as identifiers. In addition, the nic tag is used to describe the maximum mtu of the network. When the system is started, the physical device will be programmed with the MTU that is the maximum of @@ -171,5 +171,5 @@ The following exit values are returned: ## SEE ALSO - dladm(1M), sysinfo(1M), vmadm(1M) + dladm(8), sysinfo(8), vmadm(8) diff --git a/man/usr/share/man/man1m/piadm.1m.md b/man/usr/share/man/man8/piadm.8.md similarity index 92% rename from man/usr/share/man/man1m/piadm.1m.md rename to man/usr/share/man/man8/piadm.8.md index f112ae95..9f99a56a 100644 --- a/man/usr/share/man/man1m/piadm.1m.md +++ b/man/usr/share/man/man8/piadm.8.md @@ -1,4 +1,4 @@ -piadm(1M) -- Manage SmartOS Platform Images +piadm(8) -- Manage SmartOS Platform Images =========================================== @@ -20,10 +20,10 @@ piadm(1M) -- Manage SmartOS Platform Images Historically, SmartOS booted off of a USB key or a read-only media like CD-ROM. The copy and version of the SmartOS software on one of these media is called a Platform Image. A Platform Image is described in - detail in the next section. The piadm(1M) utility enables and manages + detail in the next section. The piadm(8) utility enables and manages the ability to instead boot directly off of a ZFS pool. - piadm(1M) manages multiple Platform Images on a bootable ZFS pool, + piadm(8) manages multiple Platform Images on a bootable ZFS pool, allowing easier updates to Platform Images and maintaining multiple Platform Images on a single boot media. The method and implementation of SmartOS booting does not change vs. a USB key or CD-ROM, but merely uses @@ -33,7 +33,7 @@ piadm(1M) -- Manage SmartOS Platform Images ## PLATFORM IMAGES A SmartOS Platform Image (PI) is identified by creation timestamp, - referred to here as a PI-stamp. One can see it in uname(1M): + referred to here as a PI-stamp. One can see it in uname(1): smartos-build(~)[0]% uname -a SunOS smartos-build 5.11 joyent_20200602T173751Z i86pc i386 i86pc @@ -43,7 +43,7 @@ piadm(1M) -- Manage SmartOS Platform Images The Platform Image is a directory containing: - - A directory structure in a format used by loader(5). + - A directory structure in a format used by loader(7). - The SmartOS `unix` kernel @@ -54,7 +54,7 @@ piadm(1M) -- Manage SmartOS Platform Images - A file containing the PI-stamp. - The SmartOS loader(5) will find a path to a Platform Image on the + The SmartOS loader(7) will find a path to a Platform Image on the bootable ZFS pool, and will load `unix` and then the boot archive. Platform images are supplied by either a gzipped tarball containing the @@ -63,7 +63,7 @@ piadm(1M) -- Manage SmartOS Platform Images ## BOOT IMAGES - In addition to platform images, the loader(5) also has a directory + In addition to platform images, the loader(7) also has a directory structure containing the loader itself and its support files. These are stamped as well with PI stamps, but are distinct from the contents of a gzipped PI tarball. Often, a PI can use an older Boot Image to boot @@ -76,7 +76,7 @@ piadm(1M) -- Manage SmartOS Platform Images directory. Loader config files can also be placed in ${BOOTPOOL}/custom, and will be used by all subsequently installed boot images. - See loader.conf(4) and loader(5) for the format of these files. + See loader.conf(5) and loader(7) for the format of these files. ## BOOTABLE POOLS @@ -88,7 +88,7 @@ piadm(1M) -- Manage SmartOS Platform Images - At least an MBR on its physical disks for BIOS booting, or if the pool was created with `zpool create -B`, an EFI System Partition - (ESP) with loader(5) installed in it. + (ESP) with loader(7) installed in it. - At least one Platform Image in /POOL/boot/platform-. @@ -128,10 +128,10 @@ piadm(1M) -- Manage SmartOS Platform Images network booting. Originally Triton Compute Nodes required a USB key which contained iPXE and booted directly into iPXE. - piadm(1M) can enable a Triton Compute Node's ZFS pool to boot iPXE, + piadm(8) can enable a Triton Compute Node's ZFS pool to boot iPXE, obviating the need for a USB key. It detects if a machine is a Triton Compute Node, and enables maintenance of iPXE on the bootable pool. Many - piadm(1M) subcommands are disabled on a Triton Compute Node. + piadm(8) subcommands are disabled on a Triton Compute Node. The layout of a Triton Compute Node bootable pool is limited to `boot` and `platform` symbolic links to a populated-with-iPXE `boot-ipxe` @@ -142,7 +142,7 @@ piadm(1M) -- Manage SmartOS Platform Images ## TRITON HEAD NODES - The piadm(1M) command can convert a USB-key-booting Triton Head Node into + The piadm(8) command can convert a USB-key-booting Triton Head Node into a ZFS-pool-booting one. It can also transfer boot duties from an existing ZFS pool to a new one. @@ -152,12 +152,12 @@ piadm(1M) -- Manage SmartOS Platform Images ## COMMANDS - The piadm(1M) command will produce more verbose output if -v is stated - prior to the command. If -vv is stated prior to the command, piadm(1M) + The piadm(8) command will produce more verbose output if -v is stated + prior to the command. If -vv is stated prior to the command, piadm(8) will produce both -v output and enable the shell's -x flag, which - produces output of all of the commands run in the piadm(1M) script. + produces output of all of the commands run in the piadm(8) script. - piadm(1M) commands and options are: + piadm(8) commands and options are: piadm activate [ZFS-pool-name] piadm assign [ZFS-pool-name] @@ -211,7 +211,7 @@ piadm(1M) -- Manage SmartOS Platform Images Triton Compute Node. For Triton Head Nodes, the -i option is also disabled. When invoked - with -e on a Head Node, the piadm(1M) command will attempt to convert + with -e on a Head Node, the piadm(8) command will attempt to convert a pool to be bootable for a Triton Head Node. If a Head Node is booting from a USB key, the boot data comes from the USB Key. If a Head Node is booting from another pool, the boot data comes from the @@ -227,7 +227,7 @@ piadm(1M) -- Manage SmartOS Platform Images Installs a new Platform Image into the bootable pool. If the source also contains the boot image (like an ISO does), the Boot Image will also be installed, if available. If there are more than one bootable - pools, a pool name will be required. piadm(1M) requires a Platform + pools, a pool name will be required. piadm(8) requires a Platform Image source. That source can be: - A PI-stamp, which will consult the well-known SmartOS PI @@ -341,7 +341,7 @@ The following exit values are returned: ## SEE ALSO - sdcadm(1), zpool(1M), loader(5) + sdcadm(1), loader.conf(5), loader(7), zpool(8) ## NOTES @@ -368,4 +368,4 @@ The following exit values are returned: If a bootable pool's boot image or platform image becomes corrupt, even if it's `zones`, a machine can still be booted with a USB stick, CD-ROM, or other method of booting SmartOS. A bootable pool can then be - repaired using piadm(1M) from the USB stick or CD-ROM. + repaired using piadm(8) from the USB stick or CD-ROM. diff --git a/man/usr/share/man/man1m/sysevent.1m.md b/man/usr/share/man/man8/sysevent.8.md similarity index 93% rename from man/usr/share/man/man1m/sysevent.1m.md rename to man/usr/share/man/man8/sysevent.8.md index 52e53d87..1be62d86 100644 --- a/man/usr/share/man/man1m/sysevent.1m.md +++ b/man/usr/share/man/man8/sysevent.8.md @@ -1,4 +1,4 @@ -# sysevent(1M) -- Sysevent watcher +# sysevent(8) -- Sysevent watcher ## SYNOPSIS @@ -6,7 +6,7 @@ ## DESCRIPTION -The `sysevent(1M)` tool allows watching for arbitrary sysevents from both the +The `sysevent(8)` tool allows watching for arbitrary sysevents from both the kernel and userland programs. This program will run indefinitely, emitting output on stdout whenever a sysevent is generated. This is a debugging tool; options and output are still evolving and may change in the future. diff --git a/man/usr/share/man/man1m/sysinfo.1m.md b/man/usr/share/man/man8/sysinfo.8.md similarity index 97% rename from man/usr/share/man/man1m/sysinfo.1m.md rename to man/usr/share/man/man8/sysinfo.8.md index ecf67f92..aee154be 100644 --- a/man/usr/share/man/man1m/sysinfo.1m.md +++ b/man/usr/share/man/man8/sysinfo.8.md @@ -1,4 +1,4 @@ -# sysinfo(1M) -- Output information about this SmartOS system. +# sysinfo(8) -- Output information about this SmartOS system. ## SYNOPSIS @@ -279,5 +279,5 @@ making changes. ## SEE ALSO - dladm(1M), hostname(1), ifconfig(1M), prtconf(1M), psrinfo(1M), smbios(1M), uname(1), zfs(1M), zpool(1M) + dladm(8), hostname(1), ifconfig(8), prtconf(8), psrinfo(8), smbios(8), uname(1), zfs(8), zpool(8) diff --git a/man/usr/share/man/man1m/vminfo.1m.md b/man/usr/share/man/man8/vminfo.8.md similarity index 86% rename from man/usr/share/man/man1m/vminfo.1m.md rename to man/usr/share/man/man8/vminfo.8.md index 684ccd29..eb35dfcb 100644 --- a/man/usr/share/man/man1m/vminfo.1m.md +++ b/man/usr/share/man/man8/vminfo.8.md @@ -1,4 +1,4 @@ -# vminfo(1M) -- Vminfod Client Tool +# vminfo(8) -- Vminfod Client Tool ## SYNOPSIS @@ -6,7 +6,7 @@ ## DESCRIPTION -`vminfo(1M)` is a tool to interface with the `vminfod` service on a machine +`vminfo(8)` is a tool to interface with the `vminfod` service on a machine using the exposed HTTP interface. It can be used for administrators to determine service level health and status. @@ -47,5 +47,5 @@ determine service level health and status. This tool should be used for interactive output only, and is not meant to provide a stable interface to use for vminfod. If you are trying to interface -with `vminfod` use the `vmadm(1M)` command (especially `vmadm events`) and, for +with `vminfod` use the `vmadm(8)` command (especially `vmadm events`) and, for internal platform code, the `vminfod/client` Node.js library. diff --git a/man/usr/share/man/man1m/ziostat.1m.md b/man/usr/share/man/man8/ziostat.8.md similarity index 92% rename from man/usr/share/man/man1m/ziostat.1m.md rename to man/usr/share/man/man8/ziostat.8.md index eefb8d11..5c5a55b5 100644 --- a/man/usr/share/man/man1m/ziostat.1m.md +++ b/man/usr/share/man/man8/ziostat.8.md @@ -1,4 +1,4 @@ -ziostat(1M) -- Report ZFS read I/O activity +ziostat(8) -- Report ZFS read I/O activity ============================================= ## SYNOPSIS @@ -14,7 +14,7 @@ can be observed. When run from a the global zone (GZ), activity from the GZ and all other NGZs can be observed. This tool is useful for determining if disk I/O is a source of -application latency. Combined with vfsstat(1M), ziostat(1M) shows +application latency. Combined with vfsstat(8), ziostat(8) shows the relative contribution of disk I/O latency to overall I/O (and therefore application) latency. @@ -63,7 +63,7 @@ Specifies the number of intervals to report. Defaults to unlimited if not specified. ## SEE ALSO - iostat(1M), vfsstat(1M), mpstat(1M) + iostat(8), vfsstat(8), mpstat(8) ## NOTES diff --git a/man/usr/share/man/man1m/zonememstat.1m b/man/usr/share/man/man8/zonememstat.8 similarity index 94% rename from man/usr/share/man/man1m/zonememstat.1m rename to man/usr/share/man/man8/zonememstat.8 index a93066d8..27820517 100644 --- a/man/usr/share/man/man1m/zonememstat.1m +++ b/man/usr/share/man/man8/zonememstat.8 @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH zonememstat 1M "12 May 2016" "SunOS 5.11" "System Administration Commands" +.TH zonememstat 8 "12 May 2016" "SunOS 5.11" "System Administration Commands" .SH NAME zonememstat \- display zone physical memory cap statistics .SH SYNOPSIS @@ -68,7 +68,7 @@ Add a row with the totals to the bottom of the output. .ad .RS 11n .rt -Show machine aliases using \fBvmadm\fR(1M). +Show machine aliases using \fBvmadm\fR(8). .RE .sp diff --git a/man/usr/share/man/man1m/zonemon.1m b/man/usr/share/man/man8/zonemon.8 similarity index 96% rename from man/usr/share/man/man1m/zonemon.1m rename to man/usr/share/man/man8/zonemon.8 index ec18d84b..14ae117a 100644 --- a/man/usr/share/man/man1m/zonemon.1m +++ b/man/usr/share/man/man8/zonemon.8 @@ -3,7 +3,7 @@ .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] -.TH zonemon 1M "8 Mar 2011" "SunOS 5.11" "System Administration Commands" +.TH zonemon 8 "8 Mar 2011" "SunOS 5.11" "System Administration Commands" .SH NAME zonemon \- display zone related troubleshooting data .SH SYNOPSIS diff --git a/src/dockerinit/mdata-client/Makefile b/src/dockerinit/mdata-client/Makefile index eb4a0c03..bead7f8a 100644 --- a/src/dockerinit/mdata-client/Makefile +++ b/src/dockerinit/mdata-client/Makefile @@ -19,7 +19,7 @@ CFLAGS = -I$(PWD) -Wall -Wextra -Werror -g -O2 -m32 LDLIBS = BINDIR = /usr/sbin -MANSECT = 1m +MANSECT = 8 MANDIR = /usr/share/man/man$(MANSECT) DESTDIR = $(PWD)/proto @@ -93,7 +93,7 @@ $(DESTDIR)$(BINDIR)/%: % cp $< $@ touch $@ -$(DESTDIR)$(MANDIR)/%.$(MANSECT): man/man1m/%.1m +$(DESTDIR)$(MANDIR)/%.$(MANSECT): man/man8/%.8 @mkdir -p $(DESTDIR)$(MANDIR) sed 's/__SECT__/$(MANSECT)/g' < $< > $@ diff --git a/src/dockerinit/mdata-client/README.md b/src/dockerinit/mdata-client/README.md index 3847e40f..f0bc1e20 100644 --- a/src/dockerinit/mdata-client/README.md +++ b/src/dockerinit/mdata-client/README.md @@ -12,10 +12,10 @@ contribution guidelines, issues, and general documentation, visit the main There are four commands provided in this consolidation: -* [mdata-list(1M)][mdata_list]; list custom metadata keys in the metadata store -* [mdata-get(1M)][mdata_get]; get the value of a particular metadata key -* [mdata-put(1M)][mdata_put]; set the value of a particular metadata key -* [mdata-delete(1M)][mdata_delete]; remove a metadata key +* [mdata-list(8)][mdata_list]; list custom metadata keys in the metadata store +* [mdata-get(8)][mdata_get]; get the value of a particular metadata key +* [mdata-put(8)][mdata_put]; set the value of a particular metadata key +* [mdata-delete(8)][mdata_delete]; remove a metadata key Manual pages for these tools are available in this repository, and are generally shipped with the OS (in the case of SmartOS) or in the package (e.g. @@ -48,8 +48,8 @@ MIT (See _LICENSE_.) [mdata_docs]: http://eng.joyent.com/mdata/ [protocol]: http://eng.joyent.com/mdata/protocol.html [datadict]: http://eng.joyent.com/mdata/datadict.html -[mdata_get]: http://smartos.org/man/1M/mdata-get -[mdata_delete]: http://smartos.org/man/1M/mdata-delete -[mdata_put]: http://smartos.org/man/1M/mdata-put -[mdata_list]: http://smartos.org/man/1M/mdata-list +[mdata_get]: http://smartos.org/man/8/mdata-get +[mdata_delete]: http://smartos.org/man/8/mdata-delete +[mdata_put]: http://smartos.org/man/8/mdata-put +[mdata_list]: http://smartos.org/man/8/mdata-list [launchpad_pkg]: https://launchpad.net/ubuntu/+source/joyent-mdata-client diff --git a/src/dockerinit/mdata-client/man/man1m/mdata-delete.1m b/src/dockerinit/mdata-client/man/man8/mdata-delete.8 similarity index 100% rename from src/dockerinit/mdata-client/man/man1m/mdata-delete.1m rename to src/dockerinit/mdata-client/man/man8/mdata-delete.8 diff --git a/src/dockerinit/mdata-client/man/man1m/mdata-get.1m b/src/dockerinit/mdata-client/man/man8/mdata-get.8 similarity index 100% rename from src/dockerinit/mdata-client/man/man1m/mdata-get.1m rename to src/dockerinit/mdata-client/man/man8/mdata-get.8 diff --git a/src/dockerinit/mdata-client/man/man1m/mdata-list.1m b/src/dockerinit/mdata-client/man/man8/mdata-list.8 similarity index 100% rename from src/dockerinit/mdata-client/man/man1m/mdata-list.1m rename to src/dockerinit/mdata-client/man/man8/mdata-list.8 diff --git a/src/dockerinit/mdata-client/man/man1m/mdata-put.1m b/src/dockerinit/mdata-client/man/man8/mdata-put.8 similarity index 100% rename from src/dockerinit/mdata-client/man/man1m/mdata-put.1m rename to src/dockerinit/mdata-client/man/man8/mdata-put.8 diff --git a/src/dockerinit/mdata-client/manifest b/src/dockerinit/mdata-client/manifest index 6fd7b37c..843dea9e 100644 --- a/src/dockerinit/mdata-client/manifest +++ b/src/dockerinit/mdata-client/manifest @@ -2,7 +2,7 @@ f usr/sbin/mdata-delete 0555 root bin f usr/sbin/mdata-get 0555 root bin f usr/sbin/mdata-list 0555 root bin f usr/sbin/mdata-put 0555 root bin -f usr/share/man/man1m/mdata-delete.1m 0444 root bin -f usr/share/man/man1m/mdata-get.1m 0444 root bin -f usr/share/man/man1m/mdata-list.1m 0444 root bin -f usr/share/man/man1m/mdata-put.1m 0444 root bin +f usr/share/man/man8/mdata-delete.8 0444 root bin +f usr/share/man/man8/mdata-get.8 0444 root bin +f usr/share/man/man8/mdata-list.8 0444 root bin +f usr/share/man/man8/mdata-put.8 0444 root bin diff --git a/src/fw/Makefile b/src/fw/Makefile index fc4b5972..86c6a5d4 100644 --- a/src/fw/Makefile +++ b/src/fw/Makefile @@ -1,5 +1,5 @@ # -# Copyright (c) 2019, Joyent, Inc. All rights reserved. +# Copyright 2022 Joyent, Inc. # @@ -32,8 +32,8 @@ JS_CHECK_TARGETS=\ test/integration/*.js \ test/lib/*.js MAN_CHECK_TARGETS=\ - man/fwadm.1m.md \ - man/fwrule.5.md + man/fwadm.8.md \ + man/fwrule.7.md # # Tool options @@ -60,15 +60,15 @@ $(NM): $(TOP)/tools/bin/rebuild-node-modules .PHONY: man -man: man/fwadm.1m.md man/fwrule.5.md +man: man/fwadm.8.md man/fwrule.7.md -man/fwadm.1m.md: man/fwadm.1m.md.in etc/examples/* - $(RAMSEY) -d etc/examples man/fwadm.1m.md.in man/fwadm.1m.md +man/fwadm.8.md: man/fwadm.8.md.in etc/examples/* + $(RAMSEY) -d etc/examples man/fwadm.8.md.in man/fwadm.8.md -man/fwrule.5.md: man/fwrule.5.header tools/fwrule/docs/rules.md.in man/fwrule.5.footer - @cat man/fwrule.5.header > $@ +man/fwrule.7.md: man/fwrule.7.header tools/fwrule/docs/rules.md.in man/fwrule.7.footer + @cat man/fwrule.7.header > $@ $(RAMSEY) -p wrap=80 tools/fwrule/docs/rules.md.in | sed -e 's,^#,##,' -e 's,<,<,g' | awk '/^## / { print toupper($$0); next } 1' >> $@ - @cat man/fwrule.5.footer >> $@ + @cat man/fwrule.7.footer >> $@ # diff --git a/src/fw/lib/fw.js b/src/fw/lib/fw.js index 0b812605..d1cd5a8d 100644 --- a/src/fw/lib/fw.js +++ b/src/fw/lib/fw.js @@ -21,7 +21,7 @@ * CDDL HEADER END * * - * Copyright 2019 Joyent, Inc. + * Copyright 2022 Joyent, Inc. * * * fwadm: Main entry points @@ -1010,7 +1010,7 @@ function compareAddrs(a1, a2) { * * 3 and 4 are the actual, important metric to sort on: priority and action * are important for ensuring that the actions taken by ipfilter are applied in - * the order that fwadm(1M) describes. + * the order that fwadm(8) describes. */ function compareRules(r1, r2) { var res; @@ -1269,7 +1269,7 @@ function prepareIPFdata(opts, log, callback) { for (var vm in conf) { var rulesIncluded = {}; var ipf4Conf = [ - '# DO NOT EDIT THIS FILE. THIS FILE IS AUTO-GENERATED BY fwadm(1M)', + '# DO NOT EDIT THIS FILE. THIS FILE IS AUTO-GENERATED BY fwadm(8)', '# AND MAY BE OVERWRITTEN AT ANY TIME.', '#', '# File generated at ' + date.toString(), @@ -1577,7 +1577,7 @@ function replaceIPFconf(file, data, ver, callback) { * each VM separately in parallel, so that failures for one don't impact * reloading others. For example, a VM may have filled up its disk, and we * now can't write out its configuration, or a VM may have stopped on us - * before we had a chance to run ipf(1M) on it. + * before we had a chance to run ipf(8) on it. */ function saveConfsAndReload(opts, ipfData, log, callback) { var ver = Date.now(0) + '.' + sprintf('%06d', process.pid); diff --git a/src/fw/lib/ipf.js b/src/fw/lib/ipf.js index b3114eaf..d5e0e06a 100644 --- a/src/fw/lib/ipf.js +++ b/src/fw/lib/ipf.js @@ -20,7 +20,7 @@ * * CDDL HEADER END * - * Copyright (c) 2016, Joyent, Inc. All rights reserved. + * Copyright 2022 Joyent, Inc. * * fwadm: ipf control functions */ @@ -115,10 +115,10 @@ function zoneReload(uuid, conf4, conf6, log, callback) { assert.func(callback, 'callback'); /* - * ipf(1M) acts on each of its arguments in the order that they are + * ipf(8) acts on each of its arguments in the order that they are * supplied. Since executing 6 commands for reloading each zone's * firewall gets expensive quickly, we perform multiple actions in - * a single ipf(1M) run: + * a single ipf(8) run: */ var args = [ // Operate on the GZ-controlled firewall @@ -150,7 +150,7 @@ function zoneReload(uuid, conf4, conf6, log, callback) { args.shift(); } - // Run ipf(1M) and reload the zone's firewall. + // Run ipf(8) and reload the zone's firewall. ipf(args, log, callback); } diff --git a/src/fw/man/fwadm.1m.md b/src/fw/man/fwadm.8.md similarity index 96% rename from src/fw/man/fwadm.1m.md rename to src/fw/man/fwadm.8.md index ac1eeef6..d5e5ead9 100644 --- a/src/fw/man/fwadm.1m.md +++ b/src/fw/man/fwadm.8.md @@ -1,4 +1,4 @@ -# fwadm(1M) -- Manage SmartOS firewall rules +# fwadm(8) -- Manage SmartOS firewall rules ## SYNOPSIS @@ -35,11 +35,11 @@ The fwadm tool allows you to manage firewall data on a SmartOS system. It is primarily used to manage firewall rules and remote VMs. Firewall rules are JSON objects. They contain a rule written in a -Domain-Specific Language, as well as other metadata. See fwrule(5) and +Domain-Specific Language, as well as other metadata. See fwrule(7) and the "EXAMPLES" section below for rule syntax. Remote VMs are JSON objects. They represent VMs on other SmartOS hosts. -The format is similar to the vmadm(1M) format with most properties omitted +The format is similar to the vmadm(8) format with most properties omitted and some simplified properties. See the "REMOTE VMS", "REMOTE VM PROPERTIES" and "EXAMPLES" sections below for details. @@ -96,7 +96,7 @@ the firewalls of any VMs affected. Arguments: Firewall rule, written in the rule DSL. See - fwrule(5) for syntax. + fwrule(7) for syntax. Examples: # Add a disabled rule with an owner by specifying it on the @@ -228,7 +228,7 @@ the firewalls of any VMs affected. Arguments: Firewall rule, written in the rule DSL. - See fwrule(5) for syntax. + See fwrule(7) for syntax. Examples: # Update a rule by specifying it on the commandline. @@ -374,7 +374,7 @@ the firewalls of any VMs affected. ## REMOTE VM PROPERTIES - Remote VMs are simplified versions of the VM objects used by vmadm(1M). + Remote VMs are simplified versions of the VM objects used by vmadm(8). They are also in a JSON format, but only the properties below will be stored and used by fwadm. All other properties will be discarded. The properties used are: @@ -387,7 +387,7 @@ the firewalls of any VMs affected. nics: - Array of nics, as per vmadm(1M). Only the "ip" property of each of + Array of nics, as per vmadm(8). Only the "ip" property of each of these nic objects is required - all other properties will be ignored. This property is used for creation of remote VMs only - it is not stored in the object. IPs from these objects will be added to the ips @@ -401,12 +401,12 @@ the firewalls of any VMs affected. tags: - vmadm(1M) tags object, mapping tag keys to values. + vmadm(8) tags object, mapping tag keys to values. uuid (required): UUID. This must not be the same as the UUID of any other remote VM or - local VM managed by vmadm(1M). + local VM managed by vmadm(8). Note that VMs can be added and updated in this simplified representation, or using the same representation as "vmadm get". This enables the output @@ -414,9 +414,9 @@ the firewalls of any VMs affected. "SUBCOMMANDS" section. -## INTERACTION WITH VMADM(1M) +## INTERACTION WITH VMADM(8) - fwadm relies on properties of VMs from vmadm(1M) in order to generate + fwadm relies on properties of VMs from vmadm(8) in order to generate firewall rules correctly. Therefore, when vmadm is used to create a new VM or update properties on an existing VM that can affect firewall rules, it will update firewall rules through fwadm accordingly. @@ -486,4 +486,4 @@ The following exit values are returned: ## SEE ALSO - vmadm(1M), fwrule(5), ipf(1M), ipfilter(5) + fwrule(7), ipfilter(7), ipf(8), vmadm(8) diff --git a/src/fw/man/fwrule.5.footer b/src/fw/man/fwrule.5.footer deleted file mode 100644 index 3272f277..00000000 --- a/src/fw/man/fwrule.5.footer +++ /dev/null @@ -1,4 +0,0 @@ - -## SEE ALSO - - fwadm(1M), vmadm(1M), ipf(1M), ipfilter(5) diff --git a/src/fw/man/fwrule.5.header b/src/fw/man/fwrule.5.header deleted file mode 100644 index a87b4630..00000000 --- a/src/fw/man/fwrule.5.header +++ /dev/null @@ -1,3 +0,0 @@ -# fwrule(5) -- SmartOS fwadm firewall rule syntax - - diff --git a/src/fw/man/fwrule.7.footer b/src/fw/man/fwrule.7.footer new file mode 100644 index 00000000..23cbeef9 --- /dev/null +++ b/src/fw/man/fwrule.7.footer @@ -0,0 +1,4 @@ + +## SEE ALSO + + ipfilter(7), fwadm(8), vmadm(8), ipf(8) diff --git a/src/fw/man/fwrule.7.header b/src/fw/man/fwrule.7.header new file mode 100644 index 00000000..818ed133 --- /dev/null +++ b/src/fw/man/fwrule.7.header @@ -0,0 +1,3 @@ +# fwrule(7) -- SmartOS fwadm firewall rule syntax + + diff --git a/src/fw/man/fwrule.5.md b/src/fw/man/fwrule.7.md similarity index 98% rename from src/fw/man/fwrule.5.md rename to src/fw/man/fwrule.7.md index 820dfb05..c8bb835e 100644 --- a/src/fw/man/fwrule.5.md +++ b/src/fw/man/fwrule.7.md @@ -1,4 +1,4 @@ -# fwrule(5) -- SmartOS fwadm firewall rule syntax +# fwrule(7) -- SmartOS fwadm firewall rule syntax ## OVERVIEW @@ -323,4 +323,4 @@ Some examples of rules that would cause this message include: ## SEE ALSO - fwadm(1M), vmadm(1M), ipf(1M), ipfilter(5) + ipfilter(7), vmadm(8), ipf(8), fwadm(8) diff --git a/src/fw/package.json b/src/fw/package.json index 815a4ad8..12d0b195 100644 --- a/src/fw/package.json +++ b/src/fw/package.json @@ -1,7 +1,7 @@ { "name": "fw", "description": "Administrative tool for managing SmartOS VM firewalls", - "version": "1.2.1", + "version": "1.2.2", "author": "Joyent (joyent.com)", "private": true, "main": "./lib/fw.js", diff --git a/src/fw/test/integration/examples.test.js b/src/fw/test/integration/examples.test.js index 91c08cb7..85c96da6 100644 --- a/src/fw/test/integration/examples.test.js +++ b/src/fw/test/integration/examples.test.js @@ -1,5 +1,5 @@ /* - * Copyright 2016, Joyent, Inc. All rights reserved. + * Copyright 2022 Joyent, Inc. * * Integration test: test that commands and payloads in etc/examples are * actually valid diff --git a/src/fw/test/integration/in-zone-enabled.test.js b/src/fw/test/integration/in-zone-enabled.test.js index e71b89bf..1215b866 100644 --- a/src/fw/test/integration/in-zone-enabled.test.js +++ b/src/fw/test/integration/in-zone-enabled.test.js @@ -1,5 +1,5 @@ /* - * Copyright (c) 2019, Joyent, Inc. + * Copyright 2022 Joyent, Inc. * * Integration tests for enabling / disabling firewalls in a VM */ diff --git a/src/fw/test/integration/ipsec.test.js b/src/fw/test/integration/ipsec.test.js index 9530dc2f..f786ce1b 100644 --- a/src/fw/test/integration/ipsec.test.js +++ b/src/fw/test/integration/ipsec.test.js @@ -1,5 +1,5 @@ /* - * Copyright 2019 Joyent, Inc. + * Copyright 2022 Joyent, Inc. * * Integration tests for rules that allow IPsec traffic into an instance. */ diff --git a/src/fw/test/lib/fw.js b/src/fw/test/lib/fw.js index 647cb991..91f54add 100644 --- a/src/fw/test/lib/fw.js +++ b/src/fw/test/lib/fw.js @@ -1,5 +1,5 @@ /* - * Copyright 2019 Joyent, Inc. + * Copyright 2022 Joyent, Inc. * * Test utilities for running fwadm commands */ diff --git a/src/fw/test/lib/vm.js b/src/fw/test/lib/vm.js index 5fad9c60..fce2761d 100644 --- a/src/fw/test/lib/vm.js +++ b/src/fw/test/lib/vm.js @@ -1,5 +1,5 @@ /* - * Copyright 2019 Joyent, Inc. + * Copyright 2022 Joyent, Inc. * * Test utilities for running vmadm commands */ diff --git a/src/img/Makefile b/src/img/Makefile index a970d360..6b40cba4 100644 --- a/src/img/Makefile +++ b/src/img/Makefile @@ -59,4 +59,4 @@ dev-install-image: mkdir -p $(INSTALLIMAGE)/tools cp -PR tools/coal-create-docker-vm.sh $(INSTALLIMAGE)/tools/ mkdir -p $(INSTALLIMAGE)/man - node ../../tools/ronnjs/bin/ronn.js man/imgadm.1m.md > $(INSTALLIMAGE)/man/imgadm.1m + node ../../tools/ronnjs/bin/ronn.js man/imgadm.8.md > $(INSTALLIMAGE)/man/imgadm.8 diff --git a/src/img/lib/cli.js b/src/img/lib/cli.js index 6136e92e..dfd32811 100644 --- a/src/img/lib/cli.js +++ b/src/img/lib/cli.js @@ -501,7 +501,7 @@ CLI.prototype.printHelp = function printHelp(cb) { ' imgadm publish -m -f ', ' publish an image to an image repo', '', - 'See `imgadm help ` or the imgadm(1m) man page for more details.' + 'See `imgadm help ` or the imgadm(8) man page for more details.' ]); /* END JSSTYLED */ diff --git a/src/img/man/imgadm.1m.md b/src/img/man/imgadm.8.md similarity index 99% rename from src/img/man/imgadm.1m.md rename to src/img/man/imgadm.8.md index c5d871f5..81f2923b 100644 --- a/src/img/man/imgadm.1m.md +++ b/src/img/man/imgadm.8.md @@ -1,4 +1,4 @@ -# imgadm(1M) -- Manage SmartOS virtual machine images +# imgadm(8) -- Manage SmartOS virtual machine images ## SYNOPSIS @@ -614,4 +614,4 @@ The following exit values are returned: ## SEE ALSO - vmadm(1M), zfs(1M) + vmadm(8), zfs(8) diff --git a/src/img/tools/dev-install b/src/img/tools/dev-install index 753b0e23..bff543b3 100755 --- a/src/img/tools/dev-install +++ b/src/img/tools/dev-install @@ -4,14 +4,14 @@ # # Install (rsync) this local imgadm install image to the given # smartos node. The node global zone must have been prepared with -# a writeable /usr/img and /usr/man/man1m for testing like this: +# a writeable /usr/img and /usr/man/man8 for testing like this: # # rm -rf /var/tmp/img \ # && cp -RP /usr/img /var/tmp/img \ # && mount -O -F lofs /var/tmp/img /usr/img \ -# && rm -rf /var/tmp/man1m \ -# && cp -RP /usr/man/man1m /var/tmp/man1m \ -# && mount -O -F lofs /var/tmp/man1m /usr/man/man1m +# && rm -rf /var/tmp/man8 \ +# && cp -RP /usr/man/man8 /var/tmp/man8 \ +# && mount -O -F lofs /var/tmp/man8 /usr/man/man8 # if [[ -n "$TRACE" ]]; then @@ -53,4 +53,4 @@ INSTALLIMAGE=/var/tmp/img-install-image rsync -av -e "$SSH" $INSTALLIMAGE/ $NODE:/usr/img/ -$SSH $NODE 'cd /usr/man/man1m && rm -f imgadm.1m && ln -s /usr/img/man/imgadm.1m' +$SSH $NODE 'cd /usr/man/man8 && rm -f imgadm.8 && ln -s /usr/img/man/imgadm.8' diff --git a/src/lib/sdc/usb-key.sh b/src/lib/sdc/usb-key.sh index 43a064b4..60e98c1e 100644 --- a/src/lib/sdc/usb-key.sh +++ b/src/lib/sdc/usb-key.sh @@ -211,10 +211,10 @@ function mount_usb_key() if /bin/bootparams | grep -q "^triton_bootpool=" ; then # Technically we shouldn't ever see "skip" here # because the only caller of mount_usb_key() with skip - # is piadm(1M)'s `install`, which can't be invoked on + # is piadm(8)'s `install`, which can't be invoked on # a Triton Head Node. Checking to be safe. if [[ "$2" == "skip" ]]; then - echo "Somehow a piadm(1M) install on a Head Node is" \ + echo "Somehow a piadm(8) install on a Head Node is" \ "happening. This is disallowed." >&2 return 1 fi @@ -226,10 +226,10 @@ function mount_usb_key() if /bin/bootparams | grep -q "^triton_installer=" ; then # Technically we shouldn't ever see "skip" here # because the only caller of mount_usb_key() with skip - # is piadm(1M)'s `install`, which can't be invoked on + # is piadm(8)'s `install`, which can't be invoked on # a Triton Head Node. Checking to be safe. if [[ "$2" == "skip" ]]; then - echo "Somehow a piadm(1M) install on a Head Node is" \ + echo "Somehow a piadm(8) install on a Head Node is" \ "happening. This is disallowed." >&2 return 1 fi diff --git a/src/nictagadm b/src/nictagadm index 8c2e9d91..711a8301 100755 --- a/src/nictagadm +++ b/src/nictagadm @@ -94,7 +94,7 @@ Subcommands: update [-l] [-p prop=value,...] [mac] vms -See nictagadm(1M) for more information +See nictagadm(8) for more information USAGE exit "$code" } diff --git a/src/node-dtrace-provider/README.md b/src/node-dtrace-provider/README.md index 6da6bff6..3486443e 100644 --- a/src/node-dtrace-provider/README.md +++ b/src/node-dtrace-provider/README.md @@ -12,7 +12,7 @@ to look at information from other runtime or system-level providers. The provider is not created in the usual way, by declaring it and then changing the build process to include it, but instead dynamically at runtime. This is done entirely in-process, and there is no background -compiler or [dtrace(1M)](https://illumos.org/man/1M/dtrace) invocation. +compiler or [dtrace(8)](https://illumos.org/man/8/dtrace) invocation. The process creating the provider need not run as root. ## INSTALL diff --git a/src/piadm.sh b/src/piadm.sh index 31716bdf..e1c88ad9 100644 --- a/src/piadm.sh +++ b/src/piadm.sh @@ -264,7 +264,7 @@ avail() { fi # The aforementioned Manta method, parsed by json(1). - # Don't print ones old enough to NOT contain piadm(1M) itself. + # Don't print ones old enough to NOT contain piadm(8) itself. # Always be silent (i.e. use ${CURL[@]}). "${CURL[@]}" "${URL_PREFIX}/?limit=1000" | json -ga -c \ "this.name.match(/Z$/) && this.name>=\"$activestamp\"" name @@ -768,7 +768,7 @@ regenerate_os() { mkdir ./os cat > ./os/pi.rc < [type,...] The info command operates on running KVM VMs only. It talks to the - vmadmd(1M) daemon and requests some information about the running VM. + vmadmd(8) daemon and requests some information about the running VM. The information is output to stdout as a JSON object with member objects for each type specified. If no types are specified, all info is included. The type values can be separated either by commas or @@ -804,7 +804,7 @@ tab-complete UUIDs rather than having to type them out for every command. default: zones//data) added to it. This dataset will be also be mounted on //data inside the zone (again by default: /zones//data) but you can change this by setting the mountpoint - option on the dataset from within the zone with zfs(1M). When using + option on the dataset from within the zone with zfs(8). When using this option, sub-datasets can be created, snapshots can be taken and many other options can be performed on this dataset from within the VM. @@ -1190,7 +1190,7 @@ tab-complete UUIDs rather than having to type them out for every command. firewall_enabled: This enables the firewall for this VM, allowing firewall rules set - by fwadm(1M) to be applied. + by fwadm(8) to be applied. Note: this property will only show up in a 'vmadm get' when it's set true. When set false the property will not appear. @@ -2235,7 +2235,7 @@ tab-complete UUIDs rather than having to type them out for every command. update: yes default: none (no limit) - See zfs(1M) `filesystem_limit` for more details. + See zfs(8) `filesystem_limit` for more details. zfs_io_priority: @@ -2256,7 +2256,7 @@ tab-complete UUIDs rather than having to type them out for every command. Specifies a compression algorithm used for this VM's root dataset. This option affects only the zoneroot dataset. Setting to 'on' is equivalent to setting to 'lzjb'. If you want more information about the specific - compression types, see the man page for zfs(1M). + compression types, see the man page for zfs(8). WARNING: If you change this value for an existing VM, only *new* data will be compressed. It will not rewrite existing data compress. @@ -2310,12 +2310,12 @@ tab-complete UUIDs rather than having to type them out for every command. update: yes default: none (no limit) - See zfs(1M) `snapshot_limit` for more details. + See zfs(8) `snapshot_limit` for more details. zlog_max_size: This property is used to set/show the maximum size for a docker zone's - stdio.log file before zoneadmd(1m) will rotate it. + stdio.log file before zoneadmd(8) will rotate it. type: integer (size in bytes) vmtype: ANY @@ -2438,7 +2438,7 @@ tab-complete UUIDs rather than having to type them out for every command. ## VM STATES The 'zone_state' field represents the state of the zone which contains the VM. -The zones(5) man page has some more information about these zone states. +The zones(7) man page has some more information about these zone states. The 'state' field defaults to the value of zone\_state, but in some cases the state indicates details of the VM that are not reflected directly by the zone. @@ -2806,11 +2806,11 @@ The following exit values are returned: ## SEE ALSO - vmadmd(1M), zonecfg(1M), zoneadm(1M), zones(5) + zones(7), vmadmd(8), zonecfg(8), zoneadm(8) ## NOTES -Some of the vmadm commands depend on the vmadmd(1M) service: +Some of the vmadm commands depend on the vmadmd(8) service: svc/system/smartdc/vmadmd:default diff --git a/src/vm/man/vmadmd.1m.md b/src/vm/man/vmadmd.8.md similarity index 93% rename from src/vm/man/vmadmd.1m.md rename to src/vm/man/vmadmd.8.md index 1e4649c8..2c559935 100644 --- a/src/vm/man/vmadmd.1m.md +++ b/src/vm/man/vmadmd.8.md @@ -1,4 +1,4 @@ -vmadmd(1M) -- virtual machine management daemon +vmadmd(8) -- virtual machine management daemon =============================================== ## SYNOPSIS @@ -8,9 +8,9 @@ vmadmd(1M) -- virtual machine management daemon ## DESCRIPTION The vmadmd daemon is designed to run in a SmartOS global zone and support - vmadm(1M) by performing some actions which require maintaining open + vmadm(8) by performing some actions which require maintaining open connections or waiting for state change events that cannot be handle in a - single run of vmadm(1M). + single run of vmadm(8). The functions vmadmd handles are: @@ -25,7 +25,7 @@ vmadmd(1M) -- virtual machine management daemon Each of these is described in more detail below. These actions are exposed through an HTTP server listening on a unix socket /tmp/vmadmd.http. - The HTTP interface is expected to only be used by vmadm(1M) and endpoints + The HTTP interface is expected to only be used by vmadm(8) and endpoints should be considered a private interface. It is documented here in order to aid understanding of its behaviour. @@ -71,7 +71,7 @@ vmadmd(1M) -- virtual machine management daemon VMs is implemented as a stop and start so this also applies when running 'vmadm reboot'. - Since the vmadm(1M) process returns once a stop request is sent, it is up + Since the vmadm(8) process returns once a stop request is sent, it is up to vmadmd to ensure that if the VM does not complete its transition by the expiry, the stop or reboot is forced. @@ -85,7 +85,7 @@ vmadmd(1M) -- virtual machine management daemon ## QMP Commands Qemu processes support a protocol called QMP for sending several types of - management commands to the hypervisor. When created with vmadm(1M) the qmp + management commands to the hypervisor. When created with vmadm(8) the qmp socket will be listening on a unix socket /zones//root/tmp/vm.qmp. vmadmd exposes some of these commands and handles sending them through QMP. The commands exposed are described below. @@ -173,17 +173,17 @@ vmadmd(1M) -- virtual machine management daemon ## SEE ALSO - vmadm(1M), zonecfg(1M), zoneadm(1M), zones(5) + zones(5), vmadm(8), zonecfg(8), zoneadm(8) ## NOTES The vmadmd service is managed by the service management - facility, smf(5), under the service identifier: + facility, smf(7), under the service identifier: svc:/system/smartdc/vmadmd:default Administrative actions on this service, such as enabling, disabling, or requesting restart, can be performed using - svcadm(1M). The service's status can be queried using the + svcadm(8). The service's status can be queried using the svcs(1) command. diff --git a/src/vm/node_modules/VM.js b/src/vm/node_modules/VM.js index fb46232d..e75f4447 100644 --- a/src/vm/node_modules/VM.js +++ b/src/vm/node_modules/VM.js @@ -1415,7 +1415,7 @@ function setQuota(opts, callback) * | zones/ | [1] | [2] | [1] | [2] | * | zones//disk | none | none | [3] | none | * - * 1. This matches the `quota` value described in `vmadm(1M)`. A default value + * 1. This matches the `quota` value described in `vmadm(8)`. A default value * of 1 GiB is used when not specified in the `vmadm` payload. Note that 1 * GiB is overkill, as this space contains small amounts of configuration * data and logs. @@ -8350,7 +8350,7 @@ function installZone(payload, log, callback) /* * Apply ZFS settings * - * These are run as separate invocations of zfs(1M) to make + * These are run as separate invocations of zfs(8) to make * debugging easier in the event of a failure. */ var props = [ diff --git a/src/vm/node_modules/sysevent-stream.js b/src/vm/node_modules/sysevent-stream.js index 9e88afcf..2f7608bc 100644 --- a/src/vm/node_modules/sysevent-stream.js +++ b/src/vm/node_modules/sysevent-stream.js @@ -40,7 +40,7 @@ var READY_TIMEOUT = 30 * 1000; module.exports = SyseventStream; /* - * Create a new sysevent stream by forking sysevent(1M). + * Create a new sysevent stream by forking sysevent(8). * * Arguments - (all properties are optional) * @@ -156,7 +156,7 @@ function SyseventStream(opts) { }; } - // construct arguments to give to sysevent(1M) + // construct arguments to give to sysevent(8) var args = ['-rj']; if (self.ses_channel) args.push('-c', self.ses_channel); @@ -166,7 +166,7 @@ function SyseventStream(opts) { args = args.concat(self.ses_subclasses); } - // fork sysevent(1M) + // fork sysevent(8) self.ses_logger.info({args: args}, 'calling /usr/sbin/sysevent %s', args.join(' ')); @@ -237,7 +237,7 @@ function SyseventStream(opts) { util.inherits(SyseventStream, stream.Transform); /* - * the transform method to process sysevent(1M) stdout line-by-line + * the transform method to process sysevent(8) stdout line-by-line */ SyseventStream.prototype._transform = function _transform(chunk, encoding, cb) { var self = this; @@ -289,7 +289,7 @@ SyseventStream.prototype.stop = function stop() { }; /* - * stop the SyseventStream and force sysevent(1M) to dump core - + * stop the SyseventStream and force sysevent(8) to dump core - * this should only be called from within this module. * * This is only to be called when the child process does something unexpected @@ -311,7 +311,7 @@ SyseventStream.prototype._abort = function _abort() { self.ses_logger.error({child: self.ses_child.pid}, '_abort() called - sending SIGABRT'); self.ses_child.kill('SIGABRT'); - var e = new Error('sysevent(1M) aborted'); + var e = new Error('sysevent(8) aborted'); self.emit('error', e); }; diff --git a/src/vm/node_modules/vminfod/vminfod.js b/src/vm/node_modules/vminfod/vminfod.js index 2039f4c9..55fe2816 100644 --- a/src/vm/node_modules/vminfod/vminfod.js +++ b/src/vm/node_modules/vminfod/vminfod.js @@ -179,7 +179,7 @@ var CONFIG_FILES = [ ]; /* - * sysinfo(1M) cache file + * sysinfo(8) cache file */ var SYSINFO_FILE = '/tmp/.sysinfo.json'; diff --git a/src/vm/node_modules/vmload/vmload-datasets.js b/src/vm/node_modules/vmload/vmload-datasets.js index cfe6b320..085728cf 100644 --- a/src/vm/node_modules/vmload/vmload-datasets.js +++ b/src/vm/node_modules/vmload/vmload-datasets.js @@ -422,7 +422,7 @@ function makeEnv() { if (name === 'LANG' || name.match(/^LC_/)) { /* * Do not copy any locale variables into the child environment. - * See environ(5) for more information about what these variables + * See environ(7) for more information about what these variables * mean. */ continue; @@ -520,7 +520,7 @@ function zfs(options, cmd, args, lineHandler, callback) * Arguments: * * 'options' - an object containing: - * 'fields' - an array of fields as in the zfs(1m) man page (required) + * 'fields' - an array of fields as in the zfs(8) man page (required) * 'types' - one or more of: filesystem, snapshot, volume. (required) * 'log' - a bunyan logger object. (required) * 'spawnZfs' - a function(options, cmd, args, lineHandler, callbackHandler) diff --git a/src/vm/node_modules/zonecfg.js b/src/vm/node_modules/zonecfg.js index 9956a54e..1217413e 100644 --- a/src/vm/node_modules/zonecfg.js +++ b/src/vm/node_modules/zonecfg.js @@ -37,7 +37,7 @@ var LOCK_PATH = '/var/run/.vm.%s.zonecfg.lockfile'; module.exports = zonecfg; /* - * Call zonecfg(1M) with a given set of arguments and optional stdin data. + * Call zonecfg(8) with a given set of arguments and optional stdin data. * A lock file will be acquired (based on the id given as the first argument, * typically a zoneuuid) to ensure that only one instance of zonecfg will be * run at a time per zone. @@ -60,7 +60,7 @@ module.exports = zonecfg; * }); * * - uuid: a zone's UUID (preferable) or zonename - * - args: arguments to pass to zonecfg(1M) as an array of strings + * - args: arguments to pass to zonecfg(8) as an array of strings * - opts: options object * - opts.log [required] bunyan logger * - opts.stdin [optional] a string to pass to the child as stdin diff --git a/src/vm/sbin/vmadm.js b/src/vm/sbin/vmadm.js index 7616ba5b..8434a2b5 100755 --- a/src/vm/sbin/vmadm.js +++ b/src/vm/sbin/vmadm.js @@ -1064,9 +1064,9 @@ function main(callback) if (err && err.code === 'ENOENT' && err.statusCode === 404) { /* * In the vminfod world, a VM not found error is expressed a - * 404 instead of a failure message directly from zoneadm(1M). + * 404 instead of a failure message directly from zoneadm(8). * Certain tools and scripts (`node-vmadm` for example) rely on - * this specific output, so we make vmadm(1M) mimic that here. + * this specific output, so we make vmadm(8) mimic that here. */ err.message = util.format( 'zoneadm: %s: No such zone configured', uuid); diff --git a/src/vm/tests/testdata/vmload-xml/bhyve-disk-sort.xml b/src/vm/tests/testdata/vmload-xml/bhyve-disk-sort.xml index d2340e17..62da3972 100644 --- a/src/vm/tests/testdata/vmload-xml/bhyve-disk-sort.xml +++ b/src/vm/tests/testdata/vmload-xml/bhyve-disk-sort.xml @@ -1,6 +1,6 @@ diff --git a/src/vm/tests/testdata/vmload-xml/c673ec7c-aca9-4a4c-a4be-52fa82b2f0cd.xml b/src/vm/tests/testdata/vmload-xml/c673ec7c-aca9-4a4c-a4be-52fa82b2f0cd.xml index 3242490d..9d910b56 100644 --- a/src/vm/tests/testdata/vmload-xml/c673ec7c-aca9-4a4c-a4be-52fa82b2f0cd.xml +++ b/src/vm/tests/testdata/vmload-xml/c673ec7c-aca9-4a4c-a4be-52fa82b2f0cd.xml @@ -1,7 +1,7 @@ diff --git a/src/vm/tests/testdata/vmload-xml/kvm-disk-sort.xml b/src/vm/tests/testdata/vmload-xml/kvm-disk-sort.xml index eff32ae6..dd263b1c 100644 --- a/src/vm/tests/testdata/vmload-xml/kvm-disk-sort.xml +++ b/src/vm/tests/testdata/vmload-xml/kvm-disk-sort.xml @@ -1,6 +1,6 @@ diff --git a/src/vm/tests/testdata/vmload-xml/lx.xml b/src/vm/tests/testdata/vmload-xml/lx.xml index 33f7e9fd..44de55b6 100644 --- a/src/vm/tests/testdata/vmload-xml/lx.xml +++ b/src/vm/tests/testdata/vmload-xml/lx.xml @@ -1,7 +1,7 @@ diff --git a/src/vm/tests/testdata/vmload-xml/maximal-joyent.xml b/src/vm/tests/testdata/vmload-xml/maximal-joyent.xml index 5722945e..7bbc94e6 100644 --- a/src/vm/tests/testdata/vmload-xml/maximal-joyent.xml +++ b/src/vm/tests/testdata/vmload-xml/maximal-joyent.xml @@ -1,7 +1,7 @@ diff --git a/src/vm/tests/testdata/vmload-xml/minimal-joyent.xml b/src/vm/tests/testdata/vmload-xml/minimal-joyent.xml index 9869a233..950838d9 100644 --- a/src/vm/tests/testdata/vmload-xml/minimal-joyent.xml +++ b/src/vm/tests/testdata/vmload-xml/minimal-joyent.xml @@ -1,6 +1,6 @@ diff --git a/tools/format_image/format_image.c b/tools/format_image/format_image.c index fc188a3e..da3aad4e 100644 --- a/tools/format_image/format_image.c +++ b/tools/format_image/format_image.c @@ -43,7 +43,7 @@ * So this tool needs to fix up then write a modified MBR, populate the GPT * header and partition tables, and write out the ESP and biosboot images. * It is sort of an unholy merger of zpool_label_disk(ZPOOL_CREATE_BOOT_LABEL) - * and installboot(1m). + * and installboot(8). * * We only currently support 512 block size, and the code isn't endian-vetted. * @@ -207,7 +207,7 @@ write_mbr(char *mbr, size_t esplen, size_t biosbootlen) /* * This is all "nops" in the MBR image: let's clear it out like - * installboot(1M) does. + * installboot(8) does. */ bzero(mbr + STAGE1_BPB_OFFSET, STAGE1_BPB_SIZE); diff --git a/tools/mancf/main.c b/tools/mancf/main.c index a811e46b..3f9bc22b 100644 --- a/tools/mancf/main.c +++ b/tools/mancf/main.c @@ -69,7 +69,7 @@ static const manorder_t cm_manorders[] = { { "9", 100 }, /* - * Prefer shutdown(1M) over shutdown(1B): + * Shouldn't need these anymore, but prefer (1M) over (1B) anyway. */ { "1m", 99 }, { "1b", -100 }, diff --git a/tools/mancheck/README.md b/tools/mancheck/README.md index 5c1d72e9..b221a76e 100644 --- a/tools/mancheck/README.md +++ b/tools/mancheck/README.md @@ -6,7 +6,7 @@ goal of running the tool is to ensure that no available manual pages are left accidentally unshipped. To that end, the `-m` and `-s` flags may be used to check shipped binaries in -directories like `usr/bin` against pages in section `1` or `1m`. In addition +directories like `usr/bin` against pages in section `1` or `8`. In addition to these checks, configuration files containing pattern-based rules may be provided to describe the full set of manual pages we expect to ship. Those files are described in the following section. @@ -36,7 +36,7 @@ For example, to exclude the `3perl` section, use this directive: All directives also accept partially specified section names using the globbing tokens described in _fnmatch(5)_. For example, to exclude section `1` and -every subsection (e.g. `1m`, `1b`, etc), use: +every subsection (e.g. `1b`, etc), use: -section "1*"; @@ -48,9 +48,9 @@ when excluding sections or subsections. If a section is not explicitly excluded in _Pass 1_, it may then be included for processing with an inclusion directive. For example, to include all of -section `7` (and subsections), use: +section `4` (and subsections), use: - +section "7*"; + +section "4*"; If a section is not matched by any inclusion directive, it is implicitly left out of all further processing. diff --git a/tools/mancheck/main.c b/tools/mancheck/main.c index 82cc4ac0..25112464 100644 --- a/tools/mancheck/main.c +++ b/tools/mancheck/main.c @@ -18,7 +18,7 @@ * * This tool ensures that no manual page is left behind. We want to audit the * traditional paths where user binaries are delivered, ensuring that we ship - * section "1" and section "1M" manual pages for all of them. + * section "1" and section "8" manual pages for all of them. */ #include @@ -65,11 +65,12 @@ static const char *cm_mpaths[] = { /* * List of manual sections where pages may be shipped for executable commands. * The case of these sections should match the case of the shipped filenames, - * e.g. "1m", not "1M". + * e.g. "1m", not "1M", BUT with illumos IPD 4 renumbering, that shouldn't + * matter any more. */ static const char *cm_mansects[] = { "1", - "1m", + "8", NULL }; @@ -225,7 +226,7 @@ parse_opts(mancheck_t *mc, int argc, char **argv) * Given a filename, e.g. "usr/bin/prstat", check to see if manual pages exist * in any of the proto or source directories (cm_mpaths) that we know contain * manual pages. The manual pages must be in a known section (cm_mansects), - * e.g. "proto/usr/share/man/man1m/prstat.1m". + * e.g. "proto/usr/share/man/man8/prstat.8". * * All matching pages are added to the string set "pages". The function * returns B_TRUE if any matching pages were found in the filesystem, or @@ -334,7 +335,7 @@ populate_shiplist(manifest_ent_t *me, void *arg) } /* - * Check if this manual page, e.g. "man1m/prstat.1m", is being shipped in + * Check if this manual page, e.g. "man8/prstat.8", is being shipped in * the manifest under the manual page tree (cm_pdir). Return B_TRUE if * it is shipped, or B_FALSE otherwise. */