Update man page for `wp media import`

Add option description for `--featured_image`, and briefly explain examples

diff --git a/man-src/media-import.txt b/man-src/media-import.txt
index e937ada..5f7e7d1 100644 (file)
--- a/man-src/media-import.txt
+++ b/man-src/media-import.txt
@@ -26,13 +26,20 @@
 
        "Description" field (post content) of attachment post
 
+* `--featured_image`
+
+       If set, set the imported image as the Featured Image of the post its attached to.
+
 
 ## EXAMPLES
 
+       # Import all jpgs in the current user's "Pictures" directory, not attached to any post
        wp media import ~/Pictures/**/*.jpg
 
-       wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture"
+       # Import a local image and set it to be the post thumbnail for a post
+       wp media import ~/Downloads/image.png --post_id=123 --title="A downloaded picture" --featured_image
 
+       # Import an image from the web
        wp media import http://s.wordpress.org/style/images/wp-header-logo.png --title='The WordPress logo' --alt="Semantic personal publishing"
 
 

diff --git a/man/media-import.1 b/man/media-import.1
index 0af6e24..03bb00a 100644 (file)
--- a/man/media-import.1
+++ b/man/media-import.1
@@ -7,7 +7,7 @@
 \fBwp\-media\-import\fR \- Sideload images from local file(s) or URL and import as attachments, optionally attached to a post
 .
 .SH "SYNOPSIS"
-wp media import \fIfile\fR\.\.\. [\-\-post_id=\fIpost_id\fR] [\-\-title=\fItitle\fR] [\-\-caption=\fIcaption\fR] [\-\-alt=\fIalt_text\fR] [\-\-desc=\fIdescription\fR]
+wp media import \fIfile\fR\.\.\. [\-\-post_id=\fIpost_id\fR] [\-\-title=\fItitle\fR] [\-\-caption=\fIcaption\fR] [\-\-alt=\fIalt_text\fR] [\-\-desc=\fIdescription\fR] [\-\-featured_image]
 .
 .SH "OPTIONS"
 .
@@ -47,16 +47,25 @@ Alt text for image (saved as post meta)
 .IP
 "Description" field (post content) of attachment post
 .
+.IP "\(bu" 4
+\fB\-\-featured_image\fR
+.
+.IP
+If set, set the imported image as the Featured Image of the post its attached to\.
+.
 .IP "" 0
 .
 .SH "EXAMPLES"
 .
 .nf
 
+# Import all jpgs in the current user\'s "Pictures" directory, not attached to any post
 wp media import ~/Pictures/**/*\.jpg
 
-wp media import ~/Downloads/image\.png \-\-post_id=123 \-\-title="A downloaded picture"
+# Import a local image and set it to be the post thumbnail for a post
+wp media import ~/Downloads/image\.png \-\-post_id=123 \-\-title="A downloaded picture" \-\-featured_image
 
+# Import an image from the web
 wp media import http://s\.wordpress\.org/style/images/wp\-header\-logo\.png \-\-title=\'The WordPress logo\' \-\-alt="Semantic personal publishing"
 .
 .fi