From c07a2a641e2da234266aaa84b9134538e2ec6d1b Mon Sep 17 00:00:00 2001 From: Dan McDonald Date: Wed, 6 Mar 2024 18:42:14 -0500 Subject: [PATCH] Apply IPD 4 fixes to man page links, also use smartos.org/man, other typos (#65) Reviewed by: Brian Bennett --- docs/configuring-smb-in-smartos.md | 4 ++-- docs/how-to-create-a-zone.md | 4 ++-- docs/lx-branded-zones.md | 2 +- docs/managing-images.md | 2 +- docs/managing-instances-with-vmamd.md | 10 +++++----- docs/performance.md | 8 ++++---- docs/references.md | 4 ++-- docs/remotely-upgrading-a-usb-key-based-deployment.md | 2 +- docs/smartos-technical-faqs.md | 2 +- 9 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/configuring-smb-in-smartos.md b/docs/configuring-smb-in-smartos.md index 804f48e..76fe897 100644 --- a/docs/configuring-smb-in-smartos.md +++ b/docs/configuring-smb-in-smartos.md @@ -120,11 +120,11 @@ are also deleted. **Important:** `-r` is the displayed resource name, `-s` is the share location, `smb` is the file system export type. See - [`sharemgr(1M)`][sharemgr-1m] for additional options. + [`sharemgr(8)`][sharemgr-8] for additional options. 12. Test with a CIFS client -[sharemgr-1m]: https://smartos.org/man/1m/sharemgr +[sharemgr-8]: https://smartos.org/man/8/sharemgr ## Advertising SMB Services via Bonjour diff --git a/docs/how-to-create-a-zone.md b/docs/how-to-create-a-zone.md index 7000d57..9220711 100644 --- a/docs/how-to-create-a-zone.md +++ b/docs/how-to-create-a-zone.md @@ -55,7 +55,7 @@ You will reference this image's UUID when you create the zone manifest. A manifest is a JSON object which describes your zone. There are many options which are fully described in the -[vmadm(1m)](https://smartos.org/man/1m/vmadm) man page. The most +[vmadm(8)](https://smartos.org/man/8/vmadm) man page. The most important are: - `brand`: This must be set to "joyent" for Zones @@ -120,6 +120,6 @@ or zlogin UUID Please refer to the manpage for -[vmadm(1m)](https://smartos.org/man/1m/vmadm) and +[vmadm(8)](https://smartos.org/man/8/vmadm) and [zlogin(1)](https://smartos.org/man/1/zlogin) respectively, for the escape sequence to exit out of console mode. diff --git a/docs/lx-branded-zones.md b/docs/lx-branded-zones.md index d0527f7..2afae24 100644 --- a/docs/lx-branded-zones.md +++ b/docs/lx-branded-zones.md @@ -5,7 +5,7 @@ machine. These are known in SmartOS as LX brand zones. LX Brand Zones run using the illumos kernel, not the Linux kernel, so while almost all user-land programs behave correctly, some kernel interfaces will not be present. If you need kernel facilities not present (e.g., nested containers, or iptables control, -etc.) it is recommended that you instead use a [VM](how-toc-create-an-hvm-zone) +etc.) it is recommended that you instead use a [VM](how-to-create-an-hvm-zone) instead. If you don't need extra kernel facilities, you may find that LX brand zones diff --git a/docs/managing-images.md b/docs/managing-images.md index 09a7b06..e1665a6 100644 --- a/docs/managing-images.md +++ b/docs/managing-images.md @@ -24,7 +24,7 @@ we look at how to create your own private image server. The default image server is . You can edit this list of sources using the `imgadm sources -a ` command, -as documented in [imgadm(1m)](https://smartos.org/man/1m/imgadm). Using +as documented in [imgadm(8)](https://smartos.org/man/8/imgadm). Using the command `imgadm update`, you'll cause the local cache (`/var/db/imgadm/imgcache.json`) to be updated with the available images on the servers found in your sources.list. Once your local cache diff --git a/docs/managing-instances-with-vmamd.md b/docs/managing-instances-with-vmamd.md index bff94bc..eae4603 100644 --- a/docs/managing-instances-with-vmamd.md +++ b/docs/managing-instances-with-vmamd.md @@ -1,9 +1,9 @@ # Managing Instances with `vmadm` This page describes some common tasks, and some tips & trics for using -[vmadm(1M)][vmadm-man] to manage instances. +[vmadm(8)][vmadm-man] to manage instances. -[vmadm-man]: https://smartos.org/man/1m/vmadm +[vmadm-man]: https://smartos.org/man/8/vmadm ## Listing instances @@ -237,7 +237,7 @@ with an alias that starts with 'a' or 'b': ## Modifying an instance Many attributes can be updated live without needing a restart. See -[`vmadm(1M)`][vmadm-man] details. +[`vmadm(8)`][vmadm-man] details. Here we can see that the quota set on the instance is 20GB. The quota value returned by `vmadm` is the same value returned by `zfs`. @@ -530,11 +530,11 @@ do a full send. -See [`zfs(1M)`][zfs-man] for information about additional send options. In +See [`zfs(8)`][zfs-man] for information about additional send options. In particular, read up on resumable transfers. This helps if you have a large dataset and/or an unreliable network. -[zfs-man]: https://smartos.org/man/1m/zfs +[zfs-man]: https://smartos.org/man/8/zfs On the destination compute node, attach the zone. This will move the zone from `configured` to `stopped`. Note: You don't need to explictly copy or create the diff --git a/docs/performance.md b/docs/performance.md index 0c883d2..34f8652 100644 --- a/docs/performance.md +++ b/docs/performance.md @@ -52,7 +52,7 @@ see also: [DTrace](dtrace.md) - [Flame on: Graphing hot paths through X server code](http://blogs.oracle.com/alanc/entry/flame_on_graphing_hot_paths) - [The Gregg Performance Series (videos)](http://smartos.org/2011/05/04/video-the-gregg-performance-series/): Tutorial videos about SmartOS performance tools: vmstat, mpstat, uptime. -- [vfsstat(1m) – Report VFS read and write activity](https://github.com/TritonDataCenter/smartos-live/blob/master/man/src/vfsstat.1m.md) -- [ziostat(1m) – Report ZFS read I/O activity](https://github.com/TritonDataCenter/smartos-live/blob/master/man/src/ziostat.1m.md) -- [zonestat(1) – report active zone statistics](https://github.com/TritonDataCenter/smartos-live/blob/master/man/src/zonestat.1.md) -- [zonestatd(1m) – zones monitoring daemon](https://github.com/TritonDataCenter/smartos-live/blob/master/man/src/zonestatd.1m.md) +- [vfsstat(8) – Report VFS read and write activity](https://smartos.org/man/8/vfsstat) +- [ziostat(8) – Report ZFS read I/O activity](https://smartos.org/man/8/ziostat) +- [zonestat(1) – report active zone statistics](https://smartos.org/man/1/zonestat) +- [zonestatd(8) – zones monitoring daemon](https://smartos.org/man/8/zonestatd) diff --git a/docs/references.md b/docs/references.md index a148339..1df69f3 100644 --- a/docs/references.md +++ b/docs/references.md @@ -5,8 +5,8 @@ users. ## SmartOS Specific Man Pages -- [vmadm(8)](https://github.com/TritonDataCenter/smartos-live/blob/master/src/vm/man/vmadm.8.md) -- [imgadm(8)](https://github.com/TritonDataCenter/smartos-live/blob/master/src/img/man/imgadm.8.md) +- [vmadm(8)](https://smartos.org/man/8/vmadm) +- [imgadm(8)](https://smartos.org/man/8/imgadm) Cheat Sheets diff --git a/docs/remotely-upgrading-a-usb-key-based-deployment.md b/docs/remotely-upgrading-a-usb-key-based-deployment.md index 0da6b1c..4ee71bc 100644 --- a/docs/remotely-upgrading-a-usb-key-based-deployment.md +++ b/docs/remotely-upgrading-a-usb-key-based-deployment.md @@ -92,7 +92,7 @@ document for the correct link and expected MD5 sums. #### Find and Mount the USB Key -The [diskinfo(1M)](https://smartos.org/man/1M/diskinfo) command displays +The [diskinfo(8)](https://smartos.org/man/8/diskinfo) command displays information about the physical disks (or other storage devices) attached to the system.  We can use this tool to find the disk device that represents the USB key. By default, the tool will display a table of all diff --git a/docs/smartos-technical-faqs.md b/docs/smartos-technical-faqs.md index ee4fc0a..5140811 100644 --- a/docs/smartos-technical-faqs.md +++ b/docs/smartos-technical-faqs.md @@ -18,7 +18,7 @@ found in the SmartOS uses `prstat` instead of top; it understands SmartOS better and has lower overhead. 'prstat -Z' is a popular invocation, although there are many other command-line options; see the [prstat man -page](http://www.illumos.org/man/8/prstat) for more details. +page](http://smartos.org/man/8/prstat) for more details. ## How do I start or stop system services?