Skip to content

Commit fa764f9

Browse files
committed
Documentation update
1 parent f16411a commit fa764f9

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

contrib/ansible-cmdb.man.1

+15
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,18 @@ Params to send to the template.
6161
.BR \-c ", " \-\-columns =\fICOL[,COL]\fR
6262
Show only given columns
6363

64+
.TP
65+
.BR \-C ", " \-\-cust\-cols =\fPATH\fR
66+
Add user-defined columns.
67+
68+
.TP
69+
.BR \-l ", " \-\-limit =\fLIMIT\fR
70+
Limit the included hosts to pattern LIMIT
71+
72+
.TP
73+
.BR \-\-exclude\-cols =\fEXCLUDE_COLUMNS\fR
74+
Exclude cols from output
75+
6476
.SH EXAMPLES
6577

6678
First, generate Ansible output for your hosts:
@@ -254,6 +266,9 @@ information on what id fields are supported by a template, take a look in the
254266
template. Usually it's the column title, but in lowercase and with spaces
255267
replaced by underscores.
256268

269+
You can add custom columns with the \fB\-C\fR (\fB\-\-cust\-cols\fR) option.
270+
Please see the online user manual for more information.
271+
257272
.SH EXTENDING
258273

259274
You can specify multiple directories that need to be scanned for output. This

docs/usage.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ Some templates, such as txt_table and html_fancy, support columns. If a
244244
template supports columns, you can use the `--columns` / `-c` command line
245245
option to specify which columns to show.
246246

247-
The `--columns` takes a comma-separated list of columns (no spaces!) which
247+
The `--columns` takes a comma separated list of columns (no spaces!) which
248248
should be shown. The columns must be specified by their `id` field. For
249249
information on what `id` fields are supported by a template, take a look in the
250250
template. Usually it's the column title, but in lowercase and with spaces
@@ -267,11 +267,8 @@ For example:
267267
db03.prod.local Debian 6.0.10 192.168.58.3 0g 1
268268
zoltar.electricmonk.nl Ubuntu 14.04 194.187.79.11 4g 2
269269

270-
For interactive templates (`html_fancy` and friends), the `--columns` option
271-
merely hides the columns by default. It doesn't remove them from the output,
272-
unlike the `csv` and other static templates. If you want to exclude columns
273-
from `html_fancy` and friends, use the `--exclude-cols` option. It works the
274-
same as `--columns`. For example:
270+
You can use the `--exclude-cols` option to exclude specific columns. It works
271+
the same as `--columns`. For example:
275272

276273
ansible-cmdb -t html_fancy_split \
277274
--exclude-cols mem_usage,swap_usage,disk_usage,physdisk_size \

0 commit comments

Comments
 (0)