From a0727cb643077f5bba7695321b79208f8c0cfd9c Mon Sep 17 00:00:00 2001 From: scribu Date: Sun, 3 Feb 2013 22:31:50 +0200 Subject: [PATCH] add some examples for user list and regenerate manpage --- man-src/user-list.txt | 6 ++++++ man/user-list.1 | 18 +++++++++++++++++- 2 files changed, 23 insertions(+), 1 deletion(-) diff --git a/man-src/user-list.txt b/man-src/user-list.txt index f725025c..8fc98a01 100644 --- a/man-src/user-list.txt +++ b/man-src/user-list.txt @@ -11,3 +11,9 @@ * `--format`=: Output list as table, CSV or JSON. Defaults to table. + +## EXAMPLES + + wp user list + + wp user list --role=administrator --format=csv diff --git a/man/user-list.1 b/man/user-list.1 index 2576b9ac..251e9f25 100644 --- a/man/user-list.1 +++ b/man/user-list.1 @@ -7,7 +7,7 @@ \fBwp\-user\-list\fR \- List users\. . .SH "SYNOPSIS" -wp user list [\-\-role=\fIrole\fR] [\-\-ids] +wp user list [\-\-role=\fIrole\fR] [\-\-ids] [\-\-format=\fIformat\fR] . .SH "OPTIONS" . @@ -22,4 +22,20 @@ Only display users with a certain role\. . .IP Return only the IDs of the found users, separated by spaces\. +. +.TP +\fB\-\-format\fR=\fIformat\fR: +. +.IP +Output list as table, CSV or JSON\. Defaults to table\. +. +.SH "EXAMPLES" +. +.nf + +wp user list + +wp user list \-\-role=administrator \-\-format=csv +. +.fi -- 2.11.0