From: Michal Suchanek <msuchanek@suse.de>
Date: Tue, 5 Sep 2017 15:24:57 +0000 (+0200)
Subject: Clarify import documentation
X-Git-Tag: 7.0.7-1~23
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=880b17e15b7234b04132f49d6bc46e312841ae0b;p=imagemagick

Clarify import documentation
---

diff --git a/ImageMagick/script/import.html b/ImageMagick/script/import.html
index 4b3ea38e8..e98df7e1f 100644
--- a/ImageMagick/script/import.html
+++ b/ImageMagick/script/import.html
@@ -54,11 +54,11 @@
 <div class="magick-header">
 <p class="text-center"><a href="import.php#usage">Example Usage</a> • <a href="import.php#options">Option Summary</a></p>
 
-<p class="lead magick-description">Use the <code>import</code> program to capture some or all of an X server screen and save the image to a file. See <a href="command-line-processing.php">Command Line Processing</a> for advice on how to structure your <code>import</code> command or see below for example usages of the command.</p>
+<p class="lead magick-description">Use the <code>import</code> program to capture some or all of an X server screen and save the image to a file. <code>import</code> captures the window selected by clicking or program argument. See <a href="command-line-processing.php">Command Line Processing</a> for advice on how to structure your <code>import</code> command or see below for example usages of the command.</p>
 
 <h2 class="magick-header"><a id="usage"></a>Example Usage</h2>
 
-<p>We list a few examples of the <code>import</code> command here to illustrate its usefulness and ease of use.  To get started, lets import an image in the JPEG format:</p>
+<p>We list a few examples of the <code>import</code> command here to illustrate its usefulness and ease of use.  To get started, lets import an image of an X11 window in the JPEG format:</p>
 
 <pre>
 import rose.jpg
diff --git a/MagickWand/import.c b/MagickWand/import.c
index 8580645b7..b28c7a58d 100644
--- a/MagickWand/import.c
+++ b/MagickWand/import.c
@@ -183,6 +183,7 @@ static MagickBooleanType ImportUsage(void)
       "-virtual-pixel method",
       "                     Constant, Edge, Mirror, or Tile",
       "-window id           select window with this id or name",
+      "                     root selects whole screen",
       (char *) NULL
     };
 
diff --git a/utilities/import.1 b/utilities/import.1
index 8d7f7852c..90d43a69b 100644
--- a/utilities/import.1
+++ b/utilities/import.1
@@ -1,6 +1,6 @@
 .TH import 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
 .SH NAME
-import \- saves any visible window on an X server and outputs it as an image file. You can capture a single window, the entire screen, or any rectangular portion of the screen.
+import \- saves any visible window on an X server and outputs it as an image file. You can capture a single window, the entire screen, or any rectangular portion of the screen. The window to capture is selected by clicking the desired window or a program option.
 .SH SYNOPSIS
 .TP
 \fBimport\fP [\fIoptions\fP] \fIoutput-file\fP
@@ -63,6 +63,7 @@ Image Settings:
   \-virtual-pixel method
                        Constant, Edge, Mirror, or Tile
   \-window id           select window with this id or name
+                        root selects the whole screen
 
 Image Operators:
   \-annotate geometry text
diff --git a/utilities/import.1.in b/utilities/import.1.in
index 226d0d087..28acd7bca 100644
--- a/utilities/import.1.in
+++ b/utilities/import.1.in
@@ -1,6 +1,6 @@
 .TH import 1 "Date: 2009/01/10 01:00:00" "ImageMagick"
 .SH NAME
-import \- saves any visible window on an X server and outputs it as an image file. You can capture a single window, the entire screen, or any rectangular portion of the screen.
+import \- saves any visible window on an X server and outputs it as an image file. You can capture a single window, the entire screen, or any rectangular portion of the screen. The window to capture is selected by clicking the desired window or a program option.
 .SH SYNOPSIS
 .TP
 \fBimport\fP [\fIoptions\fP] \fIoutput-file\fP
@@ -63,6 +63,7 @@ Image Settings:
   \-virtual-pixel method
                        Constant, Edge, Mirror, or Tile
   \-window id           select window with this id or name
+                        root selects the whole screen
 
 Image Operators:
   \-annotate geometry text