diff options
Diffstat (limited to 'lisp/image/image-dired-external.el')
| -rw-r--r-- | lisp/image/image-dired-external.el | 52 |
1 files changed, 25 insertions, 27 deletions
diff --git a/lisp/image/image-dired-external.el b/lisp/image/image-dired-external.el index b3ee4b36ad3..9f35e17a7e6 100644 --- a/lisp/image/image-dired-external.el +++ b/lisp/image/image-dired-external.el @@ -86,15 +86,15 @@ using the NeuQuant algorithm." (if (executable-find "pngquant") '("--ext" "-nq8.png" "%t") ; same extension as "pngnq" '("-f" "%t")) - "Arguments to pass `image-dired-cmd-pngnq-program'. -Available format specifiers are the same as in + "Arguments to pass to `image-dired-cmd-pngnq-program'. +Value can use the same format specifiers as in `image-dired-cmd-create-thumbnail-options'." :type '(repeat (string :tag "Argument")) :version "29.1") (defcustom image-dired-cmd-pngcrush-program (executable-find "pngcrush") "The file name of the `pngcrush' program. -It optimizes the compression of PNG images. Also it adds PNG textual chunks +It optimizes the compression of PNG images. It also adds PNG textual chunks with the information required by the Thumbnail Managing Standard." :type '(choice (const :tag "Not Set" nil) file)) @@ -110,7 +110,7 @@ with the information required by the Thumbnail Managing Standard." "-text" "b" "Thumb::URI" "file://%f" "%q" "%t") "Arguments for `image-dired-cmd-pngcrush-program'. -The available %-format specifiers are the same as in +The value can use the same %-format specifiers as in `image-dired-cmd-create-thumbnail-options', with \"%q\" for a temporary file name (typically generated by pnqnq)." :version "26.1" @@ -123,7 +123,7 @@ temporary file name (typically generated by pnqnq)." (defcustom image-dired-cmd-optipng-options '("-o5" "%t") "Arguments passed to `image-dired-cmd-optipng-program'. -Available format specifiers are described in +The value can use format specifiers described in `image-dired-cmd-create-thumbnail-options'." :version "26.1" :type '(repeat (string :tag "Argument")) @@ -139,14 +139,14 @@ Available format specifiers are described in "-thumbnail" "%wx%h>" "png:%t"))) (if (executable-find "gm") (cons "convert" opts) opts)) "Options for creating thumbnails according to the Thumbnail Managing Standard. -The available %-format specifiers are the same as in +The value can use the same %-format specifiers as in `image-dired-cmd-create-thumbnail-options', with \"%m\" for file modification time." :type '(repeat (string :tag "Argument")) :version "29.1") (defcustom image-dired-cmd-rotate-original-program "jpegtran" - "Executable used to rotate original image. + "Executable program used to rotate original image. Used together with `image-dired-cmd-rotate-original-options'." :type 'file) @@ -154,11 +154,11 @@ Used together with `image-dired-cmd-rotate-original-options'." '("-rotate" "%d" "-copy" "all" "-outfile" "%t" "%o") "Arguments of command used to rotate original image. Used with `image-dired-cmd-rotate-original-program'. -Available format specifiers are: %d which is replaced by the -number of (positive) degrees to rotate the image, normally 90 or -270 \(for 90 degrees right and left), %o which is replaced by the -original image file name and %t which is replaced by -`image-dired-temp-image-file'." +The value can use the following format specifiers: +%d which is replaced by the number of (positive) degrees +to rotate the image, normally 90 or 270 (for 90 degrees right and left), +%o which is replaced by the original image file name +and %t which is replaced by `image-dired-temp-image-file'." :version "26.1" :type '(repeat (string :tag "Argument"))) @@ -176,9 +176,10 @@ Used together with `image-dired-cmd-write-exif-data-options'." (defcustom image-dired-cmd-write-exif-data-options '("-%t=%v" "%f") "Arguments of command used to write EXIF data. Used with `image-dired-cmd-write-exif-data-program'. -Available format specifiers are: %f which is replaced by -the image file name, %t which is replaced by the tag name and %v -which is replaced by the tag value." +The value can use the following format specifiers are: +%f which is replaced by the image file name, +%t which is replaced by the tag name +and %v which is replaced by the tag value." :version "26.1" :type '(repeat (string :tag "Argument"))) @@ -206,7 +207,7 @@ which is replaced by the tag value." "Time when `display-thumbs' was called.") (defvar image-dired-queue nil - "List of items in the queue. + "List of items in the Image-Dired queue. Each item has the form (ORIGINAL-FILE TARGET-FILE).") (defvar image-dired-queue-active-jobs 0 @@ -214,13 +215,13 @@ Each item has the form (ORIGINAL-FILE TARGET-FILE).") (defvar image-dired-queue-active-limit (min 4 (max 2 (/ (num-processors) 2))) "Maximum number of concurrent jobs permitted for generating images. -Increase at own risk. If you want to experiment with this, +Increase at your own risk. If you want to experiment with this, consider setting `image-dired-debug' to a non-nil value to see the time spent on generating thumbnails. Run `clear-image-cache' and remove the cached thumbnail files between each trial run.") (defun image-dired-pngnq-thumb (spec) - "Quantize thumbnail described by format SPEC with pngnq(1)." + "Quantize thumbnail described by format SPEC with command `pngnq'." (let ((process (apply #'start-process "image-dired-pngnq" nil image-dired-cmd-pngnq-program @@ -243,7 +244,7 @@ and remove the cached thumbnail files between each trial run.") process)) (defun image-dired-pngcrush-thumb (spec) - "Optimize thumbnail described by format SPEC with pngcrush(1)." + "Optimize thumbnail described by format SPEC with command `pngcrush'." ;; If pngnq wasn't run, then the THUMB-nq8.png file does not exist. ;; pngcrush needs an infile and outfile, so we just copy THUMB to ;; THUMB-nq8.png and use the latter as a temp file. @@ -268,7 +269,7 @@ and remove the cached thumbnail files between each trial run.") process)) (defun image-dired-optipng-thumb (spec) - "Optimize thumbnail described by format SPEC with optipng(1)." + "Optimize thumbnail described by format SPEC with command `optipng'." (let ((process (apply #'start-process "image-dired-optipng" nil image-dired-cmd-optipng-program @@ -354,7 +355,8 @@ and remove the cached thumbnail files between each trial run.") (defun image-dired-thumb-queue-run () "Run a queued job if one exists and not too many jobs are running. -Queued items live in `image-dired-queue'." +Queued items live in `image-dired-queue'. +Number of simultaneous jobs is limited by `image-dired-queue-active-limit'." (while (and image-dired-queue (< image-dired-queue-active-jobs image-dired-queue-active-limit)) @@ -414,7 +416,7 @@ The new file will be named THUMBNAIL-FILE." The file name should be unique as long as you do not take more than one picture per second. The original file name is suffixed at the end for traceability. The format of the returned file name is -YYYY_MM_DD_HH_MM_DD_ORIG_FILE_NAME.jpg. Used from +YYYY_MM_DD_HH_MM_ss_ORIG_FILE_NAME.jpg. Used from `image-dired-copy-with-exif-file-name'." (let (data no-exif-data-found) (if (not (eq 'jpeg (image-type (expand-file-name file)))) @@ -434,7 +436,7 @@ YYYY_MM_DD_HH_MM_DD_ORIG_FILE_NAME.jpg. Used from (file-name-nondirectory file)))) (defun image-dired-thumbnail-set-image-description () - "Set the ImageDescription EXIF tag for the original image. + "Set the ImageDescription EXIF tag for the original image at point. If the image already has a value for this tag, it is used as the default value at the prompt." (interactive nil image-dired-thumbnail-mode) @@ -466,8 +468,4 @@ default value at the prompt." (provide 'image-dired-external) -;; Local Variables: -;; nameless-current-name: "image-dired" -;; End: - ;;; image-dired-external.el ends here |