Include a Other Software section in Help file
[geeqie.git] / geeqie.1
index c8a3f37..828239e 100644 (file)
--- a/geeqie.1
+++ b/geeqie.1
@@ -23,7 +23,7 @@ Geeqie \- GTK based multiformat image viewer
 
 .SH OPTIONS
 .B
-.IP +t,\-\-with\-tools
+.IP \+t,\-\-with\-tools
 Force the toolbox to be shown.
 .br
 .B
@@ -39,20 +39,262 @@ Start in full screen mode.
 Start in slideshow mode.
 .br
 .B
-.IP \-l,\-\-list
+.IP \-l,\-\-list[files...][collections...]
 Open collection window for command line files.
 .br
 .B
-.IP \-\-debug
+.IP \-\-blank
+Start with blank file list.
+.br
+.B
+.IP \-\-geometry=XxY+XOFF+YOFF
+Set main window location.
+.br
+.B
+.IP \-n,\-\-new-instance
+Open a new instance of Geeqie.
+.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.
+.br
+.B
+.IP \-\-disable-clutter
+Disable use of Clutter library (i.e. GPU accel.).
+
+.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>|layout\ ID
+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>|<URL>
+Open FILE or URL, bring Geeqie window to the top.
+.br
+.B
+.IP \-\-file:<FILE>|<URL>
+Open FILE or URL, bring Geeqie window to the top.
+.br
+.B
+.IP File:<FILE>|<URL>
+Open FILE or URL, do not bring Geeqie window to the top.
+.br
+.B
+.IP \-\-File:<FILE>|<URL>
+Open FILE or URL, do not bring Geeqie window to the top.
+.br
+.B
+.IP \-\-tell
+Print filename [and Collection] of current image.
+.br
+.B
+.IP \-\-pixel\-info
+Print X, Y and RGB of mouse pointer on current image.
+.br
+.B
+.IP \-\-get\-rectangle
+Get rectangle co-ordinates.
+.br
+.B
+.IP \-\-get\-render\-intent
+Get render intent.
+.br
+.B
+.IP \-\-get\-filelist:[<FOLDER>]
+Get list of files and class.
+.br
+.B
+.IP \-\-get\-filelist-recurse:[<FOLDER>]
+Get list of file and class recursive.
+.br
+.B
+.IP \-\-get\-collection:<COLLECTION>
+Get collection content.
+.br
+.B
+.IP \-\-get\-collection\-list
+Get collection list.
+.br
+.B
+.IP \-\-get\-file\-info
+Get file info.
+.br
+.B
+.IP view:<FILE>
+Open FILE in new window.
+.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 \-\-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 \-\-geometry=[XxY][+XOFF+YOFF]
+Set window geometry.
+.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
+.B
+.IP \-\-PWD:<PWD>
+Use PWD as working directory for following commands.
+.br
+.B
+.IP \-\-print0
+Terminate returned data with null character instead of newline.
+.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.
@@ -466,13 +708,67 @@ delete selected files
 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.
 .SH BUGS
-Please send bug reports and feedback to geeqie-devel@lists.sourceforge.net
+Please send bug reports and feedback to https://github.com/BestImageViewer/geeqie/issues
 .SH AUTHOR
 .B John Ellis
 <johne@verizon.net>