Screenshot.cfg

Package: WA2L/WinTools 1.2.08
Section: Configuration Files (4)
Updated: 25 January 2024
Index Return to Main Contents

 

NAME

Screenshot.cfg - configuration file for ScreenshotTray and Screenshot

 

SYNOPSIS

WA2LWinTools/etc/Screenshot.cfg

 

AVAILABILITY

WA2L/WinTools

 

DESCRIPTION

This is the optional configuration file for ScreenshotTray and the legacy Screenshot command.

 

FILEFORMAT

Rows starting with a # are considered as comments.

The file format is OPTION=VALUE

Between the OPTION , the = and the VALUE are no spaces.

You can comment out any OPTION or completely remove the related setting line to use the default settings.

 

OPTIONS

OUTPUTDIR
screen capture output directory. The directory specified must exist, else the default directory is used.

Example: OUTPUTDIR=%INSTALLDRIVE%:\data\screenshots

Default: OUTPUTDIR=%INSTALLDIR%\var\db\screenshot

OUTPUTSUBDIR
screen capture subdirectory in output directory. If the sub-directory specified does not exists it is created in the OUTPUTDIR.

Example: OUTPUTSUBDIR=%YEAR%-%MONTH%-%DAY%

Default: OUTPUTSUBDIR=

INTERVAL
automatic capture interval in seconds of the ScreenshotTray command when the related tray menu item is selected.

Example: INTERVAL=10

Default: INTERVAL=5

SOUNDFILE
play a (short) acoustic signal when a screenshot using ScreenshotTray is saved. However, the sound is only played if the 'Acoustic Screenshot Signal' setting is activated in the tray menu item.

Example: SOUNDFILE=%INSTALLDIR%\lib\ScreenshotTray-CLICK.wav

Default: SOUNDFILE=%INSTALLDIR%\lib\ScreenshotTray-WOOSH.wav

 

EXAMPLES

1) Simple example configuration file

#
# WA2LWinTools/etc/Screenshot.cfg - Configuration file for Screenshot
#
# [00] 18.08.2021 CWa   Initial Version
#

OUTPUTDIR=%INSTALLDRIVE%:\data\screenshots
OUTPUTSUBDIR=%YEAR%-%MONTH%-%DAY%
INTERVAL=10

 

SEE ALSO

wintoolsintro(1), lpath(3), screenshot(1), screenshottray(1)

 

NOTES

The following variables can be used for Screenshot in the configuration file: %INSTALLDRIVE%, %INSTALLDIR%, %TEMP%, %TMP%, %USERNAME%, %DOMAINNAME%, %HOSTNAME%, %YEAR%, %MONTH%, %DAY%, and %MYDOCUMENTS%.

The following variables can be additionally used for ScreenshotTray in the configuration file: %SYSTEMROOT%, %APPDATA%, %LOCALAPPDATA%, %HOMEDRIVE% and %HOMEPATH%.

Furthermore ScreenshotTray understands labels (see: lpath(3)) in the OUTPUTDIR and SOUNDFILE settings.

 

BUGS

-

 

AUTHOR

screenshot.cfg was developed by Christian Walther. Send suggestions and bug reports to wa2l@users.sourceforge.net .

 

COPYRIGHT

Copyright © 2021 Christian Walther

This is free software; see WA2LWinTools/man/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.


 

Index

NAME
SYNOPSIS
AVAILABILITY
DESCRIPTION
FILEFORMAT
OPTIONS
EXAMPLES
SEE ALSO
NOTES
BUGS
AUTHOR
COPYRIGHT

This document was created by man2html using the manual pages.
Time: 16:32:56 GMT, September 14, 2024