File: smemstat.8

package info (click to toggle)
smemstat 0.02.13-1
  • links: PTS
  • area: main
  • in suites: sid, trixie
  • size: 148 kB
  • sloc: ansic: 1,298; python: 59; makefile: 41
file content (110 lines) | stat: -rw-r--r-- 3,305 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH SMEMSTAT 8 "January 11, 2024"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
smemstat \- report memory usage with shared memory divided proportionally
.br

.SH SYNOPSIS
.B smemstat
[options]
.RI [ delay " [" count ]]
.br

.SH DESCRIPTION
smemstat reports the physical memory usage taking into consideration shared
memory.  

Swap reports memory that is swapped out to disk. Unshared memory is reported
as USS (Unique Set Size).  Unshared memory including the proportion of shared
memory is reported as the PSS (Proportional Set Size).  The non-swapped
physical memory is reported as the RSS (Resident Set Size).

Running with root privilege will report all user space processes, otherwise
running without will just report the current user's processes.

If a delay and count are not specified, a snapshot of the current memory used by
the user's processes is report.

If a delay in seconds is specified, smemstat will periodically show any per-process changes in
memory; the interval being the specified delay.  This will run indefinitely until 
a SIGINT is caught.   Specifying count will repeat the periodic output count number of times.

.SH OPTIONS
smemstat options are as follow:
.TP
.B \-a
show memory size change with up arrow \[u2191] (increase) and down arrow \[u2193] (decrease)
.TP
.B \-c
get command information from processes comm field
.TP
.B \-d
strip directory basename off command information
.TP
.B \-g
report memory in gigabytes
.TP
.B \-h
show help
.TP
.B \-k
report memory in kilobytes
.TP
.B \-l
show long (full) command information
.TP
.B \-m
report memory in megabytes
.TP
.B \-o file
output data into a JSON formatted file
.TP
.B \-p proclist
specify a comma separated list of processes to monitor. The
process list may contain one or more PIDs or process names.
.TP
.B \-q 
run quietly, only really makes sense with \-o option
.TP
.B \-s
show short command information
.TP
.B \-t
top mode, show top changes of memory
.TP
.B \-T
top mode, show top consumers of memory
.PP
When running in 'top mode', pressing 'q' will quit, 'a' toggles the memory
change arrow, 't' toggles the top consumers of memory view.
.SH SEE ALSO
.BR cpustat (8),
.BR eventstat (8),
.BR forkstat (8),
.BR top (1),
.BR vmstat (8)
.SH AUTHOR
smemstat was written by Colin Ian King <[email protected]>
.PP
This manual page was written by Colin Ian King <[email protected]>,
for the Ubuntu project (but may be used by others).
.SH COPYRIGHT
Copyright \(co 2014-2021 Canonical Ltd, Copyright \(co 2021-2024 Colin Ian King.
.br
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.