diff options
Diffstat (limited to 'sys-utils/lsmem.1')
-rw-r--r-- | sys-utils/lsmem.1 | 95 |
1 files changed, 95 insertions, 0 deletions
diff --git a/sys-utils/lsmem.1 b/sys-utils/lsmem.1 new file mode 100644 index 000000000..bb457dd74 --- /dev/null +++ b/sys-utils/lsmem.1 @@ -0,0 +1,95 @@ +.TH LSMEM 1 "October 2016" "util-linux" "User Commands" +.SH NAME +lsmem \- list the ranges of available memory with their online status +.SH SYNOPSIS +.B lsmem +.RB [ \-h "] [" \-V "] [" \-a "] [" \-s " \fIdirectory\fP] [" \-e [=\fIlist\fP]| \-p [=\fIlist\fP]] +.br +.SH DESCRIPTION +The \fBlsmem\fP command lists the ranges of available memory with their online +status. The listed memory blocks correspond to the memory block representation +in sysfs. The command also shows the memory block size and the amount of memory +in online and offline state. +.sp +By default \fBlsmem\fP prints a human readable output table with the RANGE, +SIZE, STATE, REMOVABLE, and BLOCK columns. +.sp +Use the \fB--extended\fP or \fB--parse\fP option to customize the output +table. You can change the table format and limit, extend, or rearrange the +table columns. +.sp +Not all columns are supported on all systems. If an unsupported column is +specified, \fBlsmem\fP prints the column but does not provide any data for it. + +.SS COLUMNS +.TP +.B RANGE +Start and end address of the memory range. +.TP +.B SIZE +Size of the memory range. +.TP +.B STATE +Indication of the online status of the memory range. State "on->off" means +that the address range is in transition from online to offline. +.TP +.B REMOVABLE +"yes" if the memory range can be set offline, "no" if it cannot be set offline. +A dash ("\-") means that the range is already offline. +.TP +.B BLOCK +Memory block number or numbers that correspond to the memory range. +.TP +.B NODE +Numa node of memory. +.SH OPTIONS +.TP +.BR \-a ", " \-\-all +List each individual memory block, instead of combining memory blocks with +similar attributes. +.TP +.BR \-e , " \-\-extended" [=\fIlist\fP] +Display extended memory information in human-readable format. + +If the \fIlist\fP argument is omitted, all columns for which data is available +are included in the command output. + +The \fIlist\fP argument is a comma-separated list of column labels that specifies +the columns to be included in the output table and their sequence in the +table. See \fBCOLUMNS\fP for valid column labels. Column labels are not case +sensitive. The specification consisting of option, equal sign (=), and \fIlist\fP +must not contain any white space. + +Examples: '\fB-e=range,size,state\fP' or '\fB--extended=NODE,state,size,RANGE\fP'. +.TP +.BR \-h ", " \-\-help +Display help text and exit. +.TP +.BR \-p , " \-\-parse" [=\fIlist\fP] +Optimize the command output for easy parsing. + +If the \fIlist\fP argument is omitted, all columns for which data is available +are included in the command output. + +The \fIlist\fP argument is a comma-separated list of column labels that specifies +the columns to be included in the output table and their sequence in the +table. See \fBCOLUMNS\fP for valid column labels. Column labels are not case +sensitive. The specification consisting of option, equal sign (=), and \fIlist\fP +must not contain any white space. + +Examples: '\fB-p=range,size,state\fP' or '\fB--parse=NODE,state,size,RANGE\fP'. +.TP +.BR \-s , " \-\-sysroot " \fIdirectory\fP +Gather memory data for a Linux instance other than the instance from which the +\fBlsmem\fP command is issued. The specified \fIdirectory\fP is the system +root of the Linux instance to be inspected. +.TP +.BR \-V ", " \-\-version +Display version information and exit. +.SH SEE ALSO +.BR chmem (8) +.SH AVAILABILITY +The \fBlsmem\fP command is part of the util-linux package and is available from +.UR ftp://\:ftp.kernel.org\:/pub\:/linux\:/utils\:/util-linux/ +Linux Kernel Archive +.UE . |