Browse Source

OS-8361 IPD 4 (man page renumbering) tracking issue

Reviewed by: Brian Bennett <brian.bennett@joyent.com>
Approved by: Brian Bennett <brian.bennett@joyent.com>
release-20220324
Dan McDonald 11 months ago committed by GitHub
parent
commit
c76f480743
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
  1. 44
      man/Makefile
  2. 2
      man/mancheck.conf
  3. 40
      man/manifest
  4. 2
      man/smartdc/man/man1/sdc-lastcomm.1
  5. 10
      man/usr/share/man/man7/joyent.7
  6. 10
      man/usr/share/man/man7/openssl.7
  7. 14
      man/usr/share/man/man8/disklayout.8.md
  8. 4
      man/usr/share/man/man8/fssstat.8
  9. 24
      man/usr/share/man/man8/fwadm.8.md.in
  10. 12
      man/usr/share/man/man8/mkzpool.8
  11. 6
      man/usr/share/man/man8/nictagadm.8.md
  12. 40
      man/usr/share/man/man8/piadm.8.md
  13. 4
      man/usr/share/man/man8/sysevent.8.md
  14. 4
      man/usr/share/man/man8/sysinfo.8.md
  15. 6
      man/usr/share/man/man8/vminfo.8.md
  16. 6
      man/usr/share/man/man8/ziostat.8.md
  17. 4
      man/usr/share/man/man8/zonememstat.8
  18. 2
      man/usr/share/man/man8/zonemon.8
  19. 4
      src/dockerinit/mdata-client/Makefile
  20. 16
      src/dockerinit/mdata-client/README.md
  21. 0
      src/dockerinit/mdata-client/man/man8/mdata-delete.8
  22. 0
      src/dockerinit/mdata-client/man/man8/mdata-get.8
  23. 0
      src/dockerinit/mdata-client/man/man8/mdata-list.8
  24. 0
      src/dockerinit/mdata-client/man/man8/mdata-put.8
  25. 8
      src/dockerinit/mdata-client/manifest
  26. 18
      src/fw/Makefile
  27. 8
      src/fw/lib/fw.js
  28. 8
      src/fw/lib/ipf.js
  29. 24
      src/fw/man/fwadm.8.md
  30. 4
      src/fw/man/fwrule.5.footer
  31. 3
      src/fw/man/fwrule.5.header
  32. 4
      src/fw/man/fwrule.7.footer
  33. 3
      src/fw/man/fwrule.7.header
  34. 4
      src/fw/man/fwrule.7.md
  35. 2
      src/fw/package.json
  36. 2
      src/fw/test/integration/examples.test.js
  37. 2
      src/fw/test/integration/in-zone-enabled.test.js
  38. 2
      src/fw/test/integration/ipsec.test.js
  39. 2
      src/fw/test/lib/fw.js
  40. 2
      src/fw/test/lib/vm.js
  41. 2
      src/img/Makefile
  42. 2
      src/img/lib/cli.js
  43. 4
      src/img/man/imgadm.8.md
  44. 10
      src/img/tools/dev-install
  45. 8
      src/lib/sdc/usb-key.sh
  46. 2
      src/nictagadm
  47. 2
      src/node-dtrace-provider/README.md
  48. 4
      src/piadm.sh
  49. 6
      src/routeinfo/main.c
  50. 6
      src/smartdc/lib/smartos_prompt_config.sh
  51. 22
      src/vm/man/vmadm.8.md
  52. 18
      src/vm/man/vmadmd.8.md
  53. 4
      src/vm/node_modules/VM.js
  54. 12
      src/vm/node_modules/sysevent-stream.js
  55. 2
      src/vm/node_modules/vminfod/vminfod.js
  56. 4
      src/vm/node_modules/vmload/vmload-datasets.js
  57. 4
      src/vm/node_modules/zonecfg.js
  58. 4
      src/vm/sbin/vmadm.js
  59. 2
      src/vm/tests/testdata/vmload-xml/bhyve-disk-sort.xml
  60. 2
      src/vm/tests/testdata/vmload-xml/c673ec7c-aca9-4a4c-a4be-52fa82b2f0cd.xml
  61. 2
      src/vm/tests/testdata/vmload-xml/kvm-disk-sort.xml
  62. 2
      src/vm/tests/testdata/vmload-xml/lx.xml
  63. 2
      src/vm/tests/testdata/vmload-xml/maximal-joyent.xml
  64. 2
      src/vm/tests/testdata/vmload-xml/minimal-joyent.xml
  65. 4
      tools/format_image/format_image.c
  66. 2
      tools/mancf/main.c
  67. 8
      tools/mancheck/README.md
  68. 11
      tools/mancheck/main.c

44
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 $< > $@

2
man/mancheck.conf

@ -14,4 +14,4 @@
* guidance.
*/
+section "5";
+section "7";

40
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

2
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)

10
man/usr/share/man/man5/joyent.5 → 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)

10
man/usr/share/man/man5/openssl.5 → 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

14
man/usr/share/man/man1m/disklayout.1m.md → 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)

4
man/usr/share/man/man1m/fssstat.1m → 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

24
man/usr/share/man/man1m/fwadm.1m.md.in → 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:
<rule> 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:
<rule> 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)

12
man/usr/share/man/man1m/mkzpool.1m → 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

6
man/usr/share/man/man1m/nictagadm.1m.md → 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)

40
man/usr/share/man/man1m/piadm.1m.md → 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-<PI-stamp>.
@ -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 <PI-stamp> [ZFS-pool-name]
piadm assign <PI-stamp> [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.

4
man/usr/share/man/man1m/sysevent.1m.md → 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.

4
man/usr/share/man/man1m/sysinfo.1m.md → 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)

6
man/usr/share/man/man1m/vminfo.1m.md → 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.

6
man/usr/share/man/man1m/ziostat.1m.md → 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

4
man/usr/share/man/man1m/zonememstat.1m → 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

2
man/usr/share/man/man1m/zonemon.1m → 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

4
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' < $< > $@

16
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

0
src/dockerinit/mdata-client/man/man1m/mdata-delete.1m → src/dockerinit/mdata-client/man/man8/mdata-delete.8

0
src/dockerinit/mdata-client/man/man1m/mdata-get.1m → src/dockerinit/mdata-client/man/man8/mdata-get.8

0
src/dockerinit/mdata-client/man/man1m/mdata-list.1m → src/dockerinit/mdata-client/man/man8/mdata-list.8

0
src/dockerinit/mdata-client/man/man1m/mdata-put.1m → src/dockerinit/mdata-client/man/man8/mdata-put.8

8
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

18
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,&lt;,<,g' | awk '/^## / { print toupper($$0); next } 1' >> $@
@cat man/fwrule.5.footer >> $@
@cat man/fwrule.7.footer >> $@
#

8
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);

8
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);
}

24
src/fw/man/fwadm.1m.md → 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:
<rule> 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:
<rule> 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)

4
src/fw/man/fwrule.5.footer

@ -1,4 +0,0 @@
## SEE ALSO
fwadm(1M), vmadm(1M), ipf(1M), ipfilter(5)

3
src/fw/man/fwrule.5.header

@ -1,3 +0,0 @@
# fwrule(5) -- SmartOS fwadm firewall rule syntax

4
src/fw/man/fwrule.7.footer

@ -0,0 +1,4 @@
## SEE ALSO
ipfilter(7), fwadm(8), vmadm(8), ipf(8)

3
src/fw/man/fwrule.7.header

@ -0,0 +1,3 @@
# fwrule(7) -- SmartOS fwadm firewall rule syntax

4
src/fw/man/fwrule.5.md → 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)

2
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",

2
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

2
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
*/

2
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.
*/

2
src/fw/test/lib/fw.js

@ -1,5 +1,5 @@
/*
* Copyright 2019 Joyent, Inc.
* Copyright 2022 Joyent, Inc.
*
* Test utilities for running fwadm commands
*/

2
src/fw/test/lib/vm.js

@ -1,5 +1,5 @@
/*
* Copyright 2019 Joyent, Inc.
* Copyright 2022 Joyent, Inc.
*
* Test utilities for running vmadm commands
*/

2
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

2
src/img/lib/cli.js

@ -501,7 +501,7 @@ CLI.prototype.printHelp = function printHelp(cb) {
' imgadm publish -m <manifest> -f <file> <imgapi-url>',
' publish an image to an image repo',
'',
'See `imgadm help <command>` or the imgadm(1m) man page for more details.'
'See `imgadm help <command>` or the imgadm(8) man page for more details.'
]);
/* END JSSTYLED */

4
src/img/man/imgadm.1m.md → 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)

10
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'

8
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

2
src/nictagadm

@ -94,7 +94,7 @@ Subcommands:
update [-l] [-p prop=value,...] <name> [mac]
vms <name>
See nictagadm(1M) for more information
See nictagadm(8) for more information
USAGE
exit "$code"
}

2
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

4
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 <<EOF
\\
\\ Generated by piadm(1M).
\\ Generated by piadm(8).
\\
\\ Assume mainmenu_options=4 for now.

6
src/routeinfo/main.c

@ -15,14 +15,14 @@
/*
* This program forms a private interface between the LX brand in
* illumos-joyent and the route configuration information stored by vmadm(1M)
* illumos-joyent and the route configuration information stored by vmadm(8)
* in SmartOS/SDC.
*
* When an LX branded zone boots, a special replacement for init(1M) is used,
* When an LX branded zone boots, a special replacement for init(8) is used,
* viz. "/usr/lib/brand/lx/lxinit". This program is responsible for
* configuring basic networking settings before starting the emulated Linux
* "init". Some of these settings are stored in the zone configuration, but
* static routes are not; they are stored by vmadm(1M) in a form that requires
* static routes are not; they are stored by vmadm(8) in a form that requires
* some processing at runtime. The route configuration is, thus, accessed
* through the "sdc:routes" metadata key from within the zone.
*

6
src/smartdc/lib/smartos_prompt_config.sh

@ -786,7 +786,7 @@ promptpool()
WARNING: failed to determine possible disk layout. It is possible that
the system detected no disks. We are launching a shell to allow you to
investigate the problem. Check for disks and their sizes with the
diskinfo(1M) command. If you do not see disks that you expect, please
diskinfo(8) command. If you do not see disks that you expect, please
determine your storage controller and reach out to the SmartOS community
if you require assistence.
@ -1135,7 +1135,7 @@ refers to a physical NIC or an aggregation. Virtual machines will be created on
top of a network tag. Setup will first create a network tag and configure a NIC
so that you can access the SmartOS global zone. After setup has been completed,