Changeset View
Changeset View
Standalone View
Standalone View
usr.bin/posixshmcontrol/posixshmcontrol.1
| Show All 21 Lines | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd February 26, 2022 | .Dd May 25, 2023 | ||||
| .Dt POSIXSHMCONTROL 1 | .Dt POSIXSHMCONTROL 1 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm posixshmcontrol | .Nm posixshmcontrol | ||||
| .Nd Control POSIX shared memory segments | .Nd Control POSIX shared memory segments | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| .Nm | .Nm | ||||
| .Ar create | .Ar create | ||||
| .Op Fl l Ar pagesize | |||||
| .Op Fl m Ar mode | .Op Fl m Ar mode | ||||
| .Op Pa path \&... | .Op Pa path \&... | ||||
| .Nm | .Nm | ||||
| .Ar rm | .Ar rm | ||||
| .Op Pa path \&... | .Op Pa path \&... | ||||
| .Nm | .Nm | ||||
| .Ar ls | .Ar ls | ||||
| .Op Fl h | .Op Fl h | ||||
| Show All 27 Lines | |||||
| subcommand, is equal to the number of references to the underlying VM | subcommand, is equal to the number of references to the underlying VM | ||||
| object. | object. | ||||
| It is almost always equal to the number of mappings +1, except | It is almost always equal to the number of mappings +1, except | ||||
| for transient references. | for transient references. | ||||
| .Pp | .Pp | ||||
| The following subcommands are provided: | The following subcommands are provided: | ||||
| .Bl -tag -width truncate | .Bl -tag -width truncate | ||||
| .It Ic create | .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. | |||||
kib: Is it clear that 'the page size' there refers to the page size specified for the option? (it is… | |||||
Done Inline ActionsIt's not as clear as it could be. Possible interpretations would be "the system page size" or "the specified page size", so I changed it to the latter. markj: It's not as clear as it could be. Possible interpretations would be "the system page size" or… | |||||
| The | The | ||||
| .Va hw.pagesizes | |||||
| sysctl variable lists the available page sizes. | |||||
| .Pp | |||||
| The optional numerical | |||||
| .Ar mode | .Ar mode | ||||
| optional numerical argument specifies initial access mode. | argument specifies the initial access mode. | ||||
| .It Ic rm | .It Ic rm | ||||
| Unlink the paths specified. | Unlink the paths specified. | ||||
| .It Ic ls | .It Ic ls | ||||
| List all linked named shared memory segments visible to the caller. | List all linked named shared memory segments visible to the caller. | ||||
| For each segment, the user and group owner, size, and path are displayed. | For each segment, the user and group owner, size, and path are displayed. | ||||
| The | The | ||||
| .Fl j | .Fl j | ||||
| option limits the output to segments within the specified | option limits the output to segments within the specified | ||||
| Show All 39 Lines | |||||
| and then enlarge it to 1M, use the sequence of commands | and then enlarge it to 1M, use the sequence of commands | ||||
| .Dl "posixshmcontrol create /2" | .Dl "posixshmcontrol create /2" | ||||
| .Dl "posixshmcontrol truncate -s 1m /2" | .Dl "posixshmcontrol truncate -s 1m /2" | ||||
| .El | .El | ||||
| .Sh SEE ALSO | .Sh SEE ALSO | ||||
| .Xr hexdump 1 , | .Xr hexdump 1 , | ||||
| .Xr stat 1 , | .Xr stat 1 , | ||||
| .Xr ftruncate 2 , | .Xr ftruncate 2 , | ||||
| .Xr mmap 2 , | |||||
| .Xr read 2 , | .Xr read 2 , | ||||
| .Xr shm_open 2 , | .Xr shm_open 2 , | ||||
| .Xr shm_unlink 2 , | .Xr shm_unlink 2 , | ||||
| .Xr stat 2 , | .Xr stat 2 , | ||||
| .Xr expand_number 3 , | .Xr expand_number 3 , | ||||
| .Xr humanize_number 3 , | .Xr humanize_number 3 , | ||||
| .Xr shm_create_largepage 3 , | |||||
| .Xr sysctl 3 | .Xr sysctl 3 | ||||
| .Sh HISTORY | .Sh HISTORY | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| command appeared in | command appeared in | ||||
| .Fx 12.1 . | .Fx 12.1 . | ||||
| .Sh AUTHORS | .Sh AUTHORS | ||||
| The | The | ||||
| .Nm | .Nm | ||||
| command and this manual page were written by | command and this manual page were written by | ||||
| .An Konstantin Belousov Aq Mt kib@freebsd.org | .An Konstantin Belousov Aq Mt kib@freebsd.org | ||||
| under sponsorship from The | under sponsorship from The | ||||
| .Fx | .Fx | ||||
| Foundation. | Foundation. | ||||
Is it clear that 'the page size' there refers to the page size specified for the option? (it is about the 'the' use, and I do not understand articles).