OSDN Git Service

add some examples for user list and regenerate manpage
authorscribu <mail@scribu.net>
Sun, 3 Feb 2013 20:31:50 +0000 (22:31 +0200)
committerscribu <mail@scribu.net>
Sun, 3 Feb 2013 20:31:50 +0000 (22:31 +0200)
man-src/user-list.txt
man/user-list.1

index f725025..8fc98a0 100644 (file)
@@ -11,3 +11,9 @@
 * `--format`=<format>:
 
        Output list as table, CSV or JSON. Defaults to table.
+
+## EXAMPLES
+
+       wp user list
+
+       wp user list --role=administrator --format=csv
index 2576b9a..251e9f2 100644 (file)
@@ -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