Skip to content

Commit 38147a8

Browse files
committed
Update --help output in README
1 parent 8b31c79 commit 38147a8

File tree

1 file changed

+24
-12
lines changed

1 file changed

+24
-12
lines changed

README.md

Lines changed: 24 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -87,31 +87,42 @@ ex:
8787
pg_activity [options] [connection string]
8888

8989
Configuration:
90-
--profile PROFILE Configuration profile matching a PROFILE.conf file in
90+
-P PROFILE, --profile PROFILE
91+
Configuration profile matching a PROFILE.conf file in
9192
${XDG_CONFIG_HOME:~/.config}/pg_activity/ or
92-
/etc/pg_activity/.
93+
/etc/pg_activity/, or a built-in profile.
9394

9495
Options:
9596
--blocksize BLOCKSIZE
9697
Filesystem blocksize (default: 4096).
97-
--rds Enable support for AWS RDS (implies --no-tempfiles and filters out the rdsadmin database from space calculation).
98+
--rds Enable support for AWS RDS (implies --no-tempfiles and
99+
filters out the rdsadmin database from space
100+
calculation).
98101
--output FILEPATH Store running queries as CSV.
99-
--no-db-size Skip total size of DB.
100-
--no-tempfiles Skip tempfile count and size.
101-
--no-walreceiver Skip walreceiver checks.
102+
--db-size, --no-db-size
103+
Enable/disable total size of DB.
104+
--tempfiles, --no-tempfiles
105+
Enable/disable tempfile count and size.
106+
--walreceiver, --no-walreceiver
107+
Enable/disable walreceiver checks.
102108
-w, --wrap-query Wrap query column instead of truncating.
103109
--duration-mode DURATION_MODE
104-
Duration mode. Values: 1-QUERY(default), 2-TRANSACTION, 3-BACKEND.
110+
Duration mode. Values: 1-QUERY(default),
111+
2-TRANSACTION, 3-BACKEND.
105112
--min-duration SECONDS
106-
Don't display queries with smaller than specified duration (in seconds).
107-
--filter FIELD:REGEX Filter activities with a (case insensitive) regular expression applied on selected fields. Known fields are: dbname.
113+
Don't display queries with smaller than specified
114+
duration (in seconds).
115+
--filter FIELD:REGEX Filter activities with a (case insensitive) regular
116+
expression applied on selected fields. Known fields
117+
are: dbname.
108118
--debug-file DEBUG_FILE
109119
Enable debug and write it to DEBUG_FILE.
110120
--version show program's version number and exit.
111121
--help Show this help message and exit.
112122

113123
Connection Options:
114-
connection string A valid connection string to the database, e.g.: 'host=HOSTNAME port=PORT user=USER dbname=DBNAME'.
124+
connection string A valid connection string to the database, e.g.:
125+
'host=HOSTNAME port=PORT user=USER dbname=DBNAME'.
115126
-h HOSTNAME, --host HOSTNAME
116127
Database server host or socket directory.
117128
-p PORT, --port PORT Database server port.
@@ -133,7 +144,7 @@ ex:
133144
--no-write Disable WRITE/s.
134145
--no-time Disable TIME+.
135146
--no-wait Disable W.
136-
--no-app-name Disable App.
147+
--no-app-name Disable APP.
137148

138149
Header display options:
139150
--no-inst-info Display instance information.
@@ -142,7 +153,8 @@ ex:
142153

143154
Other display options:
144155
--hide-queries-in-logs
145-
Disable log_min_duration_statements and log_min_duration_sample for pg_activity.
156+
Disable log_min_duration_statements and
157+
log_min_duration_sample for pg_activity.
146158
--refresh REFRESH Refresh rate. Values: 0.5, 1, 2, 3, 4, 5 (default: 2).
147159

148160
## Configuration

0 commit comments

Comments
 (0)