If you write own contributed commands do not list it in this man page, due to the fact that your change would be lost after an upgrade of WA2L/edrc. If you send your contributed command to the author of WA2L/edrc your command will be added to this list.
To see where to place manual pages of your own contributed commands, see contrib(1m).
There are some similarities in the syntax to the C programming language.
The standard math library is enabled.
See also: bc(1), contrib.calc(1), contrib.kalc(1).
See also: contrib.kalc(1), contrib.bc(1).
The checklist command can also be started from a recovery script.
In this case the environment variable $EDRC_CONTRIB_CHECKLIST_ROOTDIR can be set to produce a checklist for a part of a recovery script tree if needed, as:
export EDRC_CONTRIB_CHECKLIST_ROOTDIR=$EDRC_ENTRY_DIR
This example produces a checklist starting in the current menu and descending.
In a restricted environment the functionality contrib.checklist.setrootdir can be added to the DENY_LIST of the edrc.cfg(4) file to deny the corresponding functionality.
In a restricted environment the functionality contrib.clock.start can be added to the DENY_LIST of the edrc.cfg(4) file to deny the corresponding functionality.
In a restricted environment the functionality contrib.countdown.init, contrib.countdown.pause, contrib.countdown.resume, contrib.countdown.end and contrib.countdown.start can be added to the DENY_LIST of the edrc.cfg(4) file to deny the corresponding functionality.
The fore- and background colors can optionally be defined in
the global config file
etc/contrib.edrc.countdown.cfg
with the settings
COUNTDOWN_FOREGROUND_COLOR=color
and
COUNTDOWN_BACKGROUND_COLOR=color
where the
color
values are numbers between
0
and
7
(black=
0,
red=
1,
green=
2,
yellow=
3,
blue=
4,
magenta=
5,
cyan=
6,
white=
7).
To set the character used to display the big counter (that is normally composed out of # characters, use the COUNTDOWN_COUNTER_CHARACTER=character setting to define a single character to be used instead. You can also use a block character, as: "█" to produce a more prominent counter effect.
The countdown state can also be viewed thru wa2ledrc_report(1).
In addition the downloaded patches can be deployed and installed. If a direct internet connection is not permitted from the system the connection via a http proxy is also supported. Furthermore the patches could also be provided on a internal web server or locally on the filesystem from where the patch installation should be performed.
In a restricted environment the functionality
contrib.edrcupgrade.start,
contrib.edrcupgrade.download,
contrib.edrcupgrade.install,
contrib.edrcupgrade.setagent,
contrib.edrcupgrade.setdir,
contrib.edrcupgrade.useproxy,
contrib.edrcupgrade.setproxy,
contrib.edrcupgrade.setproxyauth,
contrib.edrcupgrade.sethttpauth
and
contrib.edrcupgrade.settargets
can be added to the
DENY_LIST
of the
edrc.cfg(4)
file to deny the corresponding functionality.
See also: bc(1), contrib.bc(1), contrib.calc(1m).
To change the translation language or leo options, enter ! in the 'term to translate' prompt.
See leo(1) for possible language and options settings.
In a restricted environment the functionality contrib.leo.setlang, contrib.leo.setproxy and contrib.leo.setopts can be added to the DENY_LIST of the edrc.cfg(4) file to deny the corresponding functionality.
In a restricted environment the functionality contrib.logs.view should be added to the DENY_LIST of the edrc.cfg(4) file.
In $EDRC_SCRIPTS_BASEDIR/logviewer.fl a list of extra log files also to be included to the LogViewer archive can be defined. Relative path names are relative to the WA2L/edrc installation.
In a restricted environment the functionality contrib.logviewer.sendpassword, contrib.logviewer.setaddress, contrib.logviewer.setdates, contrib.logviewer.setdir, contrib.logviewer.setemptyxlogs, contrib.logviewer.setmode and contrib.logviewer.setpassword can be added to the DENY_LIST of the edrc.cfg(4) file to deny the related functionality in the command.
If the setting TIMESTAMPS=ON is set within the notepad file, automatically a timestamp in the military format is added when opening the file for editing.
In a restricted environment the functionality contrib.notepad.edit, contrib.notepad.view, contrib.notepad.display, contrib.notepad.more and contrib.countdown.grep can be added to the DENY_LIST of the edrc.cfg(4) file to deny the corresponding functionality.
The notepad has the name notepad.<edrc_config>.txt and is saved to the $EDRC_CONTRIB_VARDIR by default. The save directory can optionally be defined in the global config file etc/contrib.edrc.notepad.cfg with the settings NOTEPAD_NOTESDIR=directory .
To change the master password, invoke: pwsafe -> edit -> change some content -> save
The password data file is saved in the $EDRC_SCRIPTS_BASEDIR/pwsafe.dat file which will be newly created from a template when pwsafe is initially called.
The only compulsory field in the password data file is HANDLE; which has to be the leftmost one.
If the direct query functionality pwsafe user@system is used the PASSWORD;, USER; and SYSTEM_OR_APPLICATION; fields must also exist.
All other columns are optional and can be changed.
In a restricted environment the functionality contrib.pwsafe.edit can be added to the DENY_LIST of the edrc.cfg(4) file to deny the functionality to edit the password data file and contrib.pwsafe.directquery to deny direct pwsafe user@system query within recovery scripts.
Because the
pwsafe
saves the data as semicolon
(;)
separated file that allows tabs and spaces to format the file,
a semicolon, space and tabulator cannot be entered
plain in the
PASSWORD
field. Therefore if your password contains a
semicolon, replace it with
[:SEMICOLON:],
if it contains a space, replace it with
[:SPACE:]
and replace a tabulator with
[:TAB:].
So if your password is
'my;secret '
the password has to be defined as
my[:SEMICOLON:]secret[:SPACE:]
in the
PASSWORD
field of the
pwsafe.
The replacement strings [:SEMICOLON:], [:SPACE:] and [:TAB:] can be changed in the optional configuration file etc/contrib.edrc.pwsafe.cfg using the SEMICOLON=string, SPACE=string and TAB=string settings.
The encrypion mode default is AES which uses ccrypt(1).
The encryption mode can be defined in the optional configuration file etc/contrib.edrc.pwsafe.cfg using the setting CRYPT_MODE=mode (example: CRYPT_MODE=AES256).
Possible encryption modes are:
ENIGMA is provided to handle password safe files produced in early versions of WA2L/edrc but should not be used for new setups.
In general a pwsafe.nolog file should exist in the edrc/contrib/edrc directory to avoid output logging for this command. This is especially important if you decide to protect the password data file with a master password because else the clear text passwords will be seen in the corresponding log files.
The pwsafe(3) command that can be called from outside of edrc ( using the command: edrc/lib/pwsafe [ -c config_file ] user@system ) allows also to access the password safe of a recovery script tree.
In this case the master password has to be provided thru the environment variable $PWSAFE_MASTERPASSWORD.
Of course one using this command should be careful about how to handle the master password.
See pwsafe(3) for more information.
In a restricted environment the functionality contrib.scriptdocbook.checklist, contrib.scriptdocbook.setdir, contrib.scriptdocbook.setmode, contrib.scriptdocbook.setpassword, contrib.scriptdocbook.sendpassword and contrib.scriptdocbook.setaddress can be added to the DENY_LIST of the edrc.cfg(4) file to deny the related functionality in the command.
A BIBLIOGRAPHY entry is added as the very end of the menu, if the file scriptdocbook.bib is created in the $EDRC_SCRIPTS_BASEDIR directory. The entries must have the following format:
[EDRC]
TITLE= EDRC
SUBTITLE= Enterprise Disaster Recovery Console
VERSION= 1.5.32
DATE= 30.01.2010
COMPANY= ACME Switzerland
AUTHOR= Walther Christian
ISBN= ISBN 0-330-35169-9
FILE= File: edrc_manpages-1.5.32.pdf
PATH= doc/edrc_manpages-1.*.pdf
URL= http://www.acme.ch/doc/edrc.html
The compulsory entry is [reference], all other entries are optional.
If the [----] reference is used, a horizontal line is inserted. For this special reference no other fields should be set.
The PATH=path/filename defines the path- and filename of the file referenced in the FILE entry.
The path/filename can be specified as follows:
If the file in PATH exists, it is copied to the ScriptDocBook and the entry in FILE is a hyperlink pointing to that included file.
If TODAY is specified in date of DATE=date, the current date will be printed. This might be useful when including configuration files into the ScriptDocBook.
When EDRCREVISION is specified in version of VERSION=version the current WA2L/edrc release is printed.
The input defaults can optionally be defined in the global config file etc/contrib.edrc.scriptdocbook.cfg and/or the local "recovery" script tree config file $EDRC_SCRIPTS_BASEDIR/scriptdocbook.cfg which has the identical format as the file var/contrib/edrc/scriptdocbook.<session name> where the inputs are persistently saved in an edrc session.
The current script tree contents is removed (and backuped to the $EDRC_SCRIPTS_BASEDIR/.sav/scriptinstall/<timestamp>/ directory) before the installation of the script tree package file.
In a restricted environment the functionality contrib.scriptinstall.install, contrib.scriptinstall.list and contrib.scriptinstall.patch can be added to the DENY_LIST of the edrc.cfg(4) file to deny the related functionality of the scriptinstall contributed command.
It is supported to stripe out the passwords stored in _env files and to exclude an existing pwsafe.dat file from the script package based on dialog input. Furthermore it can be selected if the recovery script tree package should be saved into a directory or if it should be mailed to a list of recipients.
The generated package can be shared among other system administrators, can be used as a backup snapshot of a recovery tree at a certain point in time (e.g. as proof after a disaster recovery (test)) or to transport a script tree from one environment to another (if a direct distribute is not possible or the code transport between environments needs to be carried out by other personnel due to segregation of duty requirements).
The generated package can be installed most efficiently on the target system using the contrib.scriptinstall(1m) contributed command.
To easily list/cat the contents of the generated package file, the llcomp(1), lscomp(1) and catcomp(1) can be used.
In a restricted environment the functionality contrib.scriptpack.cpconfig, contrib.scriptpack.cpfiles, contrib.scriptpack.setdir, contrib.scriptpack.passwdstrip, contrib.scriptpack.pwsaferm, contrib.scriptpack.setmode, contrib.scriptpack.setaddress, contrib.scriptpack.sendpassword and contrib.scriptpack.setpassword can be added to the DENY_LIST of the edrc.cfg(4) file to deny the related functionality of the scriptpack contributed command.
The input defaults can optionally be defined in the config file etc/contrib.edrc.scriptpack.cfg which has the identical format as the file var/contrib/edrc/scriptpack.<session name> where the inputs are persistently saved in an edrc session.
In $EDRC_SCRIPTS_BASEDIR/scriptpack.fl a list of other files (one per line) and directories also to be saved to the script package can be defined. Relative path names are relative to the WA2L/edrc installation.
The (include) list can contain wildcards as known from the ls and find commands. To test an entry run the 'find entry' command.
To exclude files from the resulting list of (included) files, list it in the [EXCLUDE] section, whereas the list entries are treated as regular expressions.
All files before a [EXCLUDE] section are treated as includes. If the includes shall be defined after the [EXCLUDE] section, an [INCLUDE] section has to be defined, else the [INCLUDE] keyword is optional.
The files listed in scriptpack.fl are packed to the $EDRC_SCRIPTS_BASEDIR/.sav/scriptpack/file/ directory and the WA2L/edrc configuration files (if chosen in the scriptpack dialog) to $EDRC_SCRIPTS_BASEDIR/.sav/scriptpack/conf/ in the script tree package file.
When the (m)ode is set to dynamic (=default) the action as defined in the scriptsequence -a action command line option is used as specified, therefore if scriptsequence is used with other actions in other menus, the related action is used.
If the (m)ode is set to query, inform or cancel the setting specified in the contributed command overrides the command line options of scriptsequence for the whole session.
When it is chosen to (d)isable and the script sequence checking, the auditing of the direct ascending menu point starts is set on hold as long as it is chosen to (e)nable the checking again (or the session is newly started).
In a restricted environment the functionality contrib.scriptsequence.print, contrib.scriptsequence.disable, contrib.scriptsequence.enable, contrib.scriptsequence.init and contrib.scriptsequence.setmode can be added to the DENY_LIST of the edrc.cfg(4) file to deny the related functionality of the scriptsequence contributed command.
In a restricted environment the functionality contrib.search.all, contrib.search.code, contrib.search.doc, contrib.search.file, and contrib.search.header, can be added to the DENY_LIST of the edrc.cfg(4) file to deny the related functionality.
In a restricted environment the functionality contrib.sessions.end can be added to the DENY_LIST of the edrc.cfg(4) file to deny the functionality to end inactive sessions.
To monitor a local file, specify /var/log/mylogfile.log at the 'file to monitor:' prompt.
To monitor a remote file specify hostname:/var/log/mylogfile.log or remoteuser@hostname:/var/log/mylogfile.log at the 'file to monitor:' prompt.
In a restricted environment the functionality contrib.tail.remote can be added to the DENY_LIST of the edrc.cfg(4) file to deny the functionality to tail -f a remote file.
This is free software; see edrc/doc/COPYING for copying conditions. There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.