Some command line options are not GNU/POSIX compliant (4)
[geeqie.git] / geeqie.1
index 12ae938..45d716b 100644 (file)
--- a/geeqie.1
+++ b/geeqie.1
-.\"Created with GNOME Manpages Editor
-.\"http://gmanedit.sourceforge.net
-.\"Sergio Rua <srua@gpul.org>
-.\"
-.\"
-.\" Geeqie manual page.
-.\" (C)2004 John Ellis <johne@verizon.net>
-.\"
-.\" This document is free to modify and distribute.
-.\"
-.TH geeqie 1 "Geeqie"
-
+.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.49.3.
+.TH GEEQIE "1" "April 2024" "Geeqie 2.4+git20240413-fc816858 GTK3" "User Commands"
 .SH NAME
-Geeqie \- GTK based multiformat image viewer
+Geeqie - GTK based multiformat image viewer
 .SH SYNOPSIS
 .B geeqie
-.RI [ options ] 
-.RI [ path ]
-.br
-
+[\fI\,options\/\fR] [\fI\,path\/\fR]
 .SH DESCRIPTION
-\fBGeeqie\fP is an interactive GTK based image viewer that supports multiple image formats, zooming, panning, thumbnails and sorting images into collections.
-
-.SH OPTIONS
-.B
-.IP \+t,\-\-with\-tools
-Force the toolbox to be shown.
-.br
-.B
-.IP \-t,\-\-without\-tools
-Force the toolbox to be hidden.
-.br
-.B
-.IP \-f,\-\-fullscreen
-Start in full screen mode.
-.br
-.B
-.IP \-s,\-\-slideshow
-Start in slideshow mode.
-.br
-.B
-.IP \-l,\-\-list[files...][collections...]
-Open collection window for command line files.
-.br
-.B
-.IP \-\-blank
-Start with blank file list.
-.br
-.B
-.IP \-\-geometry=XxY+XOFF+YOFF
-Set main window location.
-.br
-.B
-.IP \-r,\-\-remote
-Send following commands to open window.
-.br
-.B
-.IP \-rh,\-\-remote-help
-Print remote command list.
-.br
-.B
-.IP \-\-debug[=level]
-Turn on debugging output.
-.br
-.B
-.IP \-g:<regexp>,\-\-grep:<regexp>
-Filter debug output.
-.br
-.B
-.IP \+w,\-\-show-log-window
-Show log window.
-.br
-.B
-.IP \-o:<FILE>,\-\-log-file:<FILE>
-Save log data to FILE.
-.br
-.B
-.IP \-v,\-\-version
-Print version.
-.br
-.B
-.IP \-h,\-\-help
-Print command line options.
-
-.SH REMOTE OPTIONS
-.B
-.IP \-n,\-\-next
-Next image.
-.br
-.B
-.IP \-b,\-\-back
-Previous image.
-.br
-.B
-.IP \-\-first
-First image.
-.br
-.B
-.IP \-\-last
-Last image.
-.br
-.B
-.IP \-f,\-\-fullscreen
-Toggle full screen.
-.br
-.B
-.IP \-fs,\-\-fullscreen-start
-Start full screen.
-.br
-.B
-.IP \-fS,\-\-fullscreen-stop
-Stop full screen.
-.br
-.B
-.IP \-s,\-\-slideshow
-Toggle slideshow.
-.br
-.B
-.IP \-ss,\-\-slideshow-start
-Start slideshow.
-.br
-.B
-.IP \-sS,\-\-slideshow-stop
-Stop slideshow.
-.br
-.B
-.IP \-\-slideshow-recurse:<FOLDER>
-Start recursive slide show in FOLDER.
-.br
-.B
-.IP \-d<[HRS:][MINS:][N][.M]>,\-\-delay=<[hrs:][mins][N][.M]>
-Set slide show delay to Hrs Mins N.M seconds.
-.br
-.B
-.IP \+t,\-\-tools-show
-Show tools.
-.br
-.B
-.IP \-t,\-\-tools-hide
-Hide tools.
-.br
-.B
-.IP \-q,\-\-quit
-Quit.
-.br
-.B
-.IP \-\-config-load:<FILE>
-Load configuration from FILE.
-.br
-.B
-.IP \-\-get-sidecars:<FILE>
-Get list of sidecars of FILE.
-.br
-.B
-.IP \-\-get-destination:<FILE>
-Get destination path of FILE.
-.br
-.B
-.IP \-\-file:<FILE>
-Open FILE, bring Geeqie window to the top.
-.br
-.B
-.IP \-\-File:<FILE>
-Open FILE, do not bring Geeqie window to the top.
-.br
-.B
-.IP \-\-tell
-Print filename of current image.
-.br
-.B
-.IP \-\-pixel\-info
-Print X, Y and RGB of mouse pointer on current image.
-.br
-.B
-.IP \-\-view:<FILE>
-Open FILE in new window.
-.br
-.B
-.IP \-\-list-clear
-Clear command line collection list.
-.br
-.B
-.IP \-\-list-add:<FILE>
-Add FILE to command line collection list.
-.br
-.B
-.IP raise
-Bring the Geeqie window to the top.
-.br
-.B
-.IP \-\-id:<ID>
-Window ID for following commands.
-.br
-.B
-.IP \-\-new-window
-Open new window.
-.br
-.B
-.IP \-\-close-window
-Close window.
-.br
-.B
-.IP \-ct:clear|clean,\-\-cache-thumbs:clear|clean
-Clear or clean thumbnail cache.
-.br
-.B
-.IP \-cs:clear|clean,\-\-cache-shared:clear|clean
-Clear or clean shared thumbnail cache.
-.br
-.B
-.IP \-cm,\-\-cache-metadata
-Clean metadata cache.
-.br
-.B
-.IP \-cr:<folder>,\-\-cache-render:<folder>
-Render thumbnails.
-.br
-.B
-.IP \-crr:<folder>,\-\-cache-render-recurse:<folder>
-Render thumbnails recursively.
-.br
-.B
-.IP \-crs:<folder>,\-\-cache-render-shared:<folder>
-Render thumbnails (see Help).
-.br
-.B
-.IP \-crsr:<folder>,\-\-cache-render-shared-recurse:<folder>
-Render thumbnails recursively (see Help).
-.br
-.B
-.IP \-\-lua:<FILE>,<lua-script>
-Run lua script on FILE.
-.br
-
-.SH USAGE
-Key naming is similar to that of \fBemacs\fP(1): \fIC-key\fP indicates that control should be held, and key should be pressed; \fIS-key\fP  indicates that shift should be held and key should be pressed; these two can be combined, also, into \fIC-S-key\fP.
-.B
-.IP left-mouse-click
-(on image) next image
-.br
-.B
-.IP middle-mouse-click
-(on image) previous image
-.br
-.B
-.IP right-mouse
-context menu
-.br
-.B
-.IP middle-mouse-drag
-drag and drop operations
-.br
-.B
-.IP mouse-wheel
-(on image) Changes to the next or previous image, or if option is enabled, scrolls the image vertically.
-.br
-.B
-.IP mouse-wheel+Shift-key
-(on image) Inverts the mouse wheel behavior between scrolling image or changing image.
-.br
-.B
-.IP mouse-wheel+Control-key
-(on image) Zooms the image in and out.
-.br
-.SS GENERAL  KEYS
-.B
-.IP PageDown
-next image
-.br
-.B
-.IP PageUp
-previous image
-.br
-.B
-.IP Home                             
-first image in list
-.br
-.B
-.IP End
-last image in list
-.br
-.B
-.IP Tab
-tab completion in path entry window
-.br
-.B
-.IP Escape
-cancel completion in path entry window or stop generating thumbnails
-.br
-.SS IMAGE KEYS
-Keys that are valid when the image part of the window is focused.
-.B
-.IP Arrows
-pan image
-.br
-.B
-.IP Shift+Arrows
-pan image faster
-.br
-.B
-.IP Space,N
-next image
-.br
-.B
-.IP Backspace,B
+Geeqie is an interactive GTK based image viewer that supports multiple image formats,
+zooming, panning, thumbnails and sorting images into collections.
+
+Generated for version:
+.PP
+Geeqie 2.4+git20240413\-fc816858
+.SS "Valid options:"
+.TP
+\fB\-\-blank\fR
+start with blank file list
+.TP
+\fB\-\-cache\-maintenance=\fR<path>
+run cache maintenance in non\-GUI mode
+.TP
+\fB\-\-disable\-clutter\fR
+disable use of Clutter library (i.e. GPU accel.)
+.TP
+\fB\-f\fR, \fB\-\-fullscreen\fR
+start in full screen mode
+.TP
+\fB\-\-geometry\fR=\fI\,WxH\/\fR+XOFF+YOFF
+set main window location
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+show this message
+.HP
+\fB\-l\fR, \fB\-\-list\fR [files] [collections] open collection window for command line
+.TP
+\fB\-n\fR, \fB\-\-new\-instance\fR
+open a new instance of Geeqie *
+.TP
+\fB\-o\fR, \fB\-\-log\-file=\fR<file>
+save log data to file
+.TP
+\fB\-r\fR, \fB\-\-remote\fR
+send following commands to open window
+.TP
+\fB\-\-remote\-help\fR
+print remote command list
+.TP
+\fB\-s\fR, \fB\-\-slideshow\fR
+start in slideshow mode
+.TP
+\fB\-T\fR, \fB\-\-with\-tools\fR
+force show of tools
+.TP
+\fB\-t\fR, \fB\-\-without\-tools\fR
+force hide of tools
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+print version info
+.TP
+\fB\-w\fR, \fB\-\-show\-log\-window\fR
+show log window
+.TP
+\fB\-\-debug\fR[=\fI\,level\/\fR]
+turn on debug output
+.TP
+\fB\-g\fR, \fB\-\-grep=\fR<regexp>
+filter debug output
+.PP
+* Normally a single set of configuration files is used for all instances.
+However, the environment variables XDG_CONFIG_HOME, XDG_CACHE_HOME, XDG_DATA_HOME
+can be used to modify this behavior on an individual basis e.g.
+.PP
+XDG_CONFIG_HOME=/tmp/a XDG_CACHE_HOME=/tmp/b geeqie
+.SS "Remote command list:"
+.TP
+\fB\-\-action=\fR<ACTION>
+execute keyboard action (See Help/Reference/Remote Keyboard Actions)
+.TP
+\fB\-\-action\-list\fR
+list available keyboard actions (some are redundant)
+.TP
+\fB\-b\fR   \fB\-\-back\fR
 previous image
-.br
-.SS FILE RELATED KEYS
-.B
-.IP C
-new empty collection
-.br
-.B
-.IP O
-open collection
-.br
-.B
-.IP D
-open the Find Duplicates window
-.br
-.B
-.IP C-F
-new folder
-.br
-.B
-.IP C-C
-copy file
-.br
-.B
-.IP C-M
-move file
-.br
-.B
-.IP C-R
-rename file
-.br
-.B
-.IP C-D,Delete
-delete file
-.br
-.B
-.IP C-N
-new window
-.br
-.B
-.IP C-W
+.TP
+\fB\-\-close\-window\fR
 close window
-.br
-.B
-.IP C-Q
+.TP
+\fB\-\-config\-load=\fR<FILE>|layout ID
+load configuration from FILE
+.TP
+\fB\-\-cache\-metadata\fR
+clean the metadata cache
+.TP
+\fB\-\-cache\-render=\fR<folder>
+render thumbnails
+.TP
+\fB\-\-cache\-render\-recurse=\fR<folder>
+render thumbnails recursively
+.TP
+\fB\-\-cache\-render\-shared=\fR<folder>
+render thumbnails (see Help)
+.TP
+\fB\-\-cache\-render\-shared\-recurse=\fR<folder>
+render thumbnails recursively (see Help)
+.TP
+\fB\-\-cache\-shared\fR=\fI\,clean\/\fR|clear
+clean or clear shared thumbnail cache
+.TP
+\fB\-\-cache\-thumbs\fR=\fI\,clean\/\fR|clear
+clean or clear thumbnail cache
+.TP
+\fB\-d\fR   \fB\-\-delay=\fR<[H=][M=][N][.M]>
+set slide show delay to Hrs Mins N.M seconds
+.TP
+\fB\-\-first\fR
+first image
+.TP
+\fB\-f\fR   \fB\-\-fullscreen\fR
+toggle full screen
+.TP
+\fB\-\-file=\fR<FILE>|<URL>
+open FILE or URL, bring Geeqie window to the top
+.TP
+\fB\-\-File=\fR<FILE>|<URL>
+open FILE or URL, do not bring Geeqie window to the top
+.TP
+\fB\-\-fullscreen\-start\fR
+start full screen
+.TP
+\fB\-\-fullscreen\-stop\fR
+stop full screen
+.TP
+\fB\-\-geometry=\fR<GEOMETRY>
+set window geometry
+.TP
+\fB\-\-get\-collection=\fR<COLLECTION>
+get collection content
+.TP
+\fB\-\-get\-collection\-list\fR
+get collection list
+.TP
+\fB\-\-get\-destination=\fR<FILE>
+get destination path of FILE (See Plugins Configuration)
+.TP
+\fB\-\-get\-file\-info\fR
+get file info
+.TP
+\fB\-\-get\-filelist\fR=\fI\,[\/\fR<FOLDER>]
+get list of files and class
+.TP
+\fB\-\-get\-filelist\-recurse\fR=\fI\,[\/\fR<FOLDER>]
+get list of files and class recursive
+.TP
+\fB\-\-get\-rectangle\fR
+get rectangle co\-ordinates
+.TP
+\fB\-\-get\-render\-intent\fR
+get render intent
+.TP
+\fB\-\-get\-selection\fR
+get list of selected files
+.TP
+\fB\-\-get\-sidecars=\fR<FILE>
+get list of sidecars of FILE
+.TP
+\fB\-\-get\-window\-list\fR
+get window list
+.TP
+\fB\-\-id=\fR<ID>
+window id for following commands
+.TP
+\fB\-\-last\fR
+last image
+.TP
+\fB\-\-list\-add=\fR<FILE>
+add FILE to command line collection list
+.TP
+\fB\-\-list\-clear\fR
+clear command line collection list
+.TP
+\fB\-\-lua=\fR<FILE>,<lua script>
+run lua script on FILE
+.TP
+\fB\-\-new\-window\fR
+new window
+.TP
+\fB\-n\fR   \fB\-\-next\fR
+next image
+.TP
+\fB\-\-pixel\-info\fR
+print pixel info of mouse pointer on current image
+.TP
+\fB\-\-print0\fR
+terminate returned data with null character instead of newline
+.TP
+\fB\-\-PWD=\fR<PWD>
+use PWD as working directory for following commands
+.TP
+\fB\-q\fR   \fB\-\-quit\fR
 quit
-.br
-.SS EDIT MENU RELATED KEYS
-.B
-.IP C-1,2..9,0
-run external editor
-.br
-.B
-.IP C-A
-select all files
-.br
-.B
-.IP C-S-A
-unselect all files
-.br
-.B
-.IP C-O
-go to the Configuration window
-.br
-.B
-.IP C-P
-display image properties
-.br
-.B
-.IP ]
-rotate image clockwise
-.br
-.B
-.IP [
-rotate image counterclockwise
-.br
-.B
-.IP S-R
-rotate image 180 degrees
-.br
-.B
-.IP S-M
-mirror image (horizontal)
-.br
-.B
-.IP S-F
-flip image (vertical)
-.br
-.SS VIEW MENU RELATED KEYS
-.B
-.IP +,=
-zoom in
-.br
-.B
-.IP -
-zoom out
-.br
-.B
-.IP Z,KeyPad-/
-zoom to original size
-.br
-.B
-.IP X,KeyPad-*
-zoom to fit window
-.br
-.B
-.IP 1,2,3,4
-zoom in to X scale factor
-.br
-.B
-.IP 9,8,7
-zoom to \-2, \-3, \-4, respectively
-.br
-.B
-.IP T
-toggle thumbnail display
-.br
-.B
-.IP C-L
-display files in list format
-.br
-.B
-.IP C-I
-display files in icon format
-.br
-.B
-.IP C-T
-toggle tree view for directories
-.br
-.B
-.IP R
-refresh file list
-.br
-.B
-.IP L
-toggle floating of file selection area
-.br
-.B
-.IP H
-toggle hiding of file selection area
-.br
-.B
-.IP F,V
-toggle full-screen mode
-.br
-.B
-.IP S
-toggle slide-show mode
-.br
-.B
-.IP P
-toggle pause of slideshow
-.br
-.B
-.IP C-E
-toggle display of exif sidebar
-.br
-.B
-.IP C-S
-toggle display of sort manager
-.br
-.SS COLLECTION WINDOW KEYS
-.B
-.IP Arrows
-move selection
-.br
-.B
-.IP Shift+Arrows
-select multiple images
-.br
-.B
-.IP Control+Arrows
-move selector without changing selection
-.br
-.B
-.IP Space
-select the image under the selector
-.br
-.B
-.IP Control+Space
-toggle selection of the image under the selector
-.br
-.B
-.IP Home
-move selector to the top image
-.br
-.B
-.IP End
-move selector to bottom image
-.br
-Adding Shift or Control to Home and End has a similar effect as adding them to the arrows.
-.B
-.IP C-A
-select all images
-.br
-.B
-.IP C-S-A
-unselect all images
-.br
-.B
-.IP Delete
-remove image form collection (does not delete the file)
-.br
-.B
-.IP C-L
-add images to collection form main file list
-.br
-.B
-.IP N
-sort collection by name
-.br
-.B
-.IP D
-sort collection by date
-.br
-.B
-.IP B
-sort collection by file size
-.br
-.B
-.IP P
-sort collection by pathname
-.br
-.B
-.IP I
-sort collection by name numerically (*)
-.br
-.B
-.IP Enter
-view image under selector in the main image window
-.br
-.B
-.IP V
-view image under selector in new window
-.br
-.B
-.IP C-1,2..9,0
-open selected image(s) in external editor
-.br
-.B
-.IP S
-save collection
-.br
-.B
-.IP C-S
-save collection as
-.br
-.B
-.IP A
-append current collection to existing collection
-.br
-.B
-.IP C-C
-copy selected files
-.br
-.B
-.IP C-M
-move selected files
-.br
-.B
-.IP C-R
-rename selected files
-.br
-.B
-.IP C-D
-delete selected files
-.br
-.B
-.IP C-W
-close window
-.br
-.SS DUPLICATES WINDOW KEYS
-.B
-.IP C-A
-select all images
-.br
-.B
-.IP C-S-A
-unselect all images
-.br
-.B
-.IP 1
-select group 1 images
-.br
-.B
-.IP 2
-select group 2 images
-.br
-.B
-.IP C-L
-add images from main window file list
-.br
-.B
-.IP C
-add selected images to new collection
-.br
-.B
-.IP Delete
-remove selected images from list
-.br
-.B
-.IP C-Delete
-clear window
-.br
-.B
-.IP Enter
-view image with focus in main window
-.br
-.B
-.IP V
-view image with focus in new window
-.br
-.B
-.IP C-1,2..9,0
-open selected image(s) in editor
-.br
-.B
-.IP C-P
-display properties window for selected images
-.br
-.B
-.IP C-C
-copy selected files
-.br
-.B
-.IP C-M
-move selected files
-.br
-.B
-.IP C-R
-rename selected files
-.br
-.B
-.IP C-D
-delete selected files
-.br
-.B
-.IP C-W
-close window
-.br
-
-.SH FILES
-The following data lists the locations Geeqie uses for various actions. The
-uppercase symbols are environment variables. If they are not set on your system
-the fallback locations are listed in parentheses. Geeqie will first attempt to
-load a configuration file from:
-
-.B /etc/geeqie/geeqierc.xml
-
-It will then continue with the following locations.
-Most of Geeqie's configuration files are contained in the folder, and sub-folders of:
-
-.B $XDG_CONFIG_HOME/geeqie/
-.B ($~/.config/geeqie/)
-
-Geeqie's standard configuration file is:
-
-.B .../geeqierc.xml
-
-An alternative configuration file may be used by executing:
-
-.B geeqie -r --config-load:<filename>
-
-Geeqie-created desktop files used by Plugins are in the folder:
-
-.B .../applications
-
-Lua script files for Lua Extensions are in the folder:
-
-.B .../lua
-
-Historic data such as last several folders visited, bookmarks, and recently used collections, as well as default print settings are contained in this text file:
-
-.B .../history
-
-Keyboard shortcut maps are contained in this text file:
-
-.B .../accels
-
-The location for Collections is in the folder:
-
-.B $XDG_DATA_HOME/geeqie/collections
-.br
-.B ($~/.local/share/geeqie/collections)
-
-The lirc Infra-red controller configuration file must be located at:
-
-.B $HOME/.lircrc
-
-Thumbnails are stored in a location specified in Thumbnail Preferences
-
-Metadata is stored either in the image file or in the location specified in Safe Delete
-
-The safe delete folder is specified in the Metadata tab of main Preferences
-
-.SH LICENSE
-Copyright (C) 1999-2004 by John Ellis.
-Copyright (C) 2004-2017 by The Geeqie Team.
-Use this software at your own risk!  
-This software released under the GNU General Public License. Please read the COPYING file for more information.
+.TP
+\fB\-\-raise\fR
+bring the Geeqie window to the top
+.TP
+\fB\-\-selection\-add\fR=\fI\,[\/\fR<FILE>]
+adds the current file (or the specified file) to the current selection
+.TP
+\fB\-\-selection\-clear\fR
+clears the current selection
+.TP
+\fB\-\-selection\-remove\fR=\fI\,[\/\fR<FILE>]
+removes the current file (or the specified file) from the current selection
+.TP
+\fB\-s\fR   \fB\-\-slideshow\fR
+toggle slide show
+.TP
+\fB\-\-slideshow\-recurse=\fR<FOLDER>
+start recursive slide show in FOLDER
+.TP
+\fB\-\-slideshow\-start\fR
+start slide show
+.TP
+\fB\-\-slideshow\-stop\fR
+stop slide show
+.TP
+\fB\-\-tell\fR
+print filename [and Collection] of current image
+.TP
+\fB\-T\fR   \fB\-\-tools\-show\fR
+show tools
+.TP
+\fB\-t\fR   \fB\-\-tools\-hide\fR
+hide tools
+.TP
+\fB\-\-view=\fR<FILE>
+open FILE in new window
+.IP
+All other command line parameters are used as plain files if they exist.
+.IP
+The name of a collection, with or without either path or extension (.gqv) may be used.
 .SH BUGS
 Please send bug reports and feedback to https://github.com/BestImageViewer/geeqie/issues
-.SH AUTHOR
-.B John Ellis
-<johne@verizon.net>
-.br
-Manpage originally prepared by
-.B Nick Rusnov
-<nick@grawk.net>
+.SH COPYRIGHT
+Copyright (C) 1999-2004 by John Ellis. Copyright (C) 2004-2024 by The Geeqie Team. Use this software  at  your
+own  risk! This  software released under the GNU General Public License. Please read the COPYING file for more
+information.
+.SH "SEE ALSO"
+Full documentation: https://www.geeqie.org/help/GuideIndex.html