git: db289ababf90 - main - posixshmcontrol.1: Document posixshmcontrol create -l

From: Mark Johnston <markj_at_FreeBSD.org>
Date: Thu, 25 May 2023 22:10:30 UTC
The branch main has been updated by markj:

URL: https://cgit.FreeBSD.org/src/commit/?id=db289ababf9053236deb945e70167947d36b8692

commit db289ababf9053236deb945e70167947d36b8692
Author:     Mark Johnston <markj@FreeBSD.org>
AuthorDate: 2023-05-25 21:08:55 +0000
Commit:     Mark Johnston <markj@FreeBSD.org>
CommitDate: 2023-05-25 22:09:55 +0000

    posixshmcontrol.1: Document posixshmcontrol create -l
    
    Reviewed by:    kib
    MFC after:      1 week
    Differential Revision:  https://reviews.freebsd.org/D40270
---
 usr.bin/posixshmcontrol/posixshmcontrol.1 | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/usr.bin/posixshmcontrol/posixshmcontrol.1 b/usr.bin/posixshmcontrol/posixshmcontrol.1
index 1d8c3438b165..292768c39ce4 100644
--- a/usr.bin/posixshmcontrol/posixshmcontrol.1
+++ b/usr.bin/posixshmcontrol/posixshmcontrol.1
@@ -27,7 +27,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd February 26, 2022
+.Dd May 25, 2023
 .Dt POSIXSHMCONTROL 1
 .Os
 .Sh NAME
@@ -36,6 +36,7 @@
 .Sh SYNOPSIS
 .Nm
 .Ar create
+.Op Fl l Ar pagesize
 .Op Fl m Ar mode
 .Op Pa path \&...
 .Nm
@@ -79,10 +80,24 @@ for transient references.
 The following subcommands are provided:
 .Bl -tag -width truncate
 .It Ic create
-Create segments with the specified paths, if not exist.
+Create segments with the specified paths, if they do not already exist.
+.Pp
+The optional
+.Ar pagesize
+argument specifies the size of the virtual pages used to map the
+object with
+.Xr mmap 2 .
+By default, the system page size is used, but on some platforms a
+larger page size can be specified.
+The size of an object backed by large pages must be a multiple of the
+specified page size.
 The
+.Va hw.pagesizes
+sysctl variable lists the available page sizes.
+.Pp
+The optional numerical
 .Ar mode
-optional numerical argument specifies initial access mode.
+argument specifies the initial access mode.
 .It Ic rm
 Unlink the paths specified.
 .It Ic ls
@@ -138,12 +153,14 @@ and then enlarge it to 1M, use the sequence of commands
 .Xr hexdump 1 ,
 .Xr stat 1 ,
 .Xr ftruncate 2 ,
+.Xr mmap 2 ,
 .Xr read 2 ,
 .Xr shm_open 2 ,
 .Xr shm_unlink 2 ,
 .Xr stat 2 ,
 .Xr expand_number 3 ,
 .Xr humanize_number 3 ,
+.Xr shm_create_largepage 3 ,
 .Xr sysctl 3
 .Sh HISTORY
 The