edrc.cfg

Package: WA2L/edrc 1.5.57
Section: Configuration Files (4)
Updated: 18 September 2020
Index Return to Main Contents

 

NAME

edrc.cfg - configuration file for edrc

 

SYNOPSIS

edrc/etc/edrc.cfg

 

AVAILABILITY

WA2L/edrc

 

DESCRIPTION

This is the configuration file for the edrc command.

It is important that on all hosts in your disaster recovery environment the configuration files with the same purpose have the same name. Otherwise the distribute EDRC command won't function correctly.

 

FILEFORMAT

The fileformat is OPTION=VALUE

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

Rows starting with a # are considered as comments.

You should not comment out any OPTION If you like to use default settings simply do not specify a VALUE.

 

OPTIONS

SCRIPTS_BASEDIR
name of the recovery scripts basedir. In this directory all recovery scripts for your environment are stored in a hierarchical directory tree. This directory is relative to the root of the WA2L/edrc installation.

Example: SCRIPTS_BASEDIR=scripts/customer

Default: SCRIPTS_BASEDIR=scripts

SCRIPTS_SHELL
path to the shell you will use the most in your recovery scripts located in the SCRIPTS_BASEDIR. This setting will be used to build a template script when you invoke the newscript command in edrc.

Example: SCRIPTS_SHELL=/bin/ksh

Default: SCRIPTS_SHELL=/bin/sh

SCRIPTS_SHELLFALLBACKS
fallback shell definitions for magic keys of recovery scripts. This fall-backs come into action, if the shell defined in the magic key of a recovery script does not exist on the system. Be aware, that only for magic keys without options the fallback shell will be resolved. For scripts having options the script must be edited and the correct shell has to be defined in the script.
The entry is a list in the format <original_shell:<fallback_shell> . The fallback resolution is performed in the order of the entries. Before resolving the entries in the SCRIPTS_SHELLFALLBACKS list, the shell as defined in the recovery script is searched in alternate locations on the system. For all shell location resolutions the $PATH is used.

Example: SCRIPTS_SHELLFALLBACKS="ksh:pfksh ksh:bash sh:ksh sh:pfsh sh:bash"

Default: SCRIPTS_SHELLFALLBACKS="ksh:bash sh:ksh sh:bash"

NLS_DATE_FORMAT
NLS date format. This format is exported to each recovery script. You should set your most used format here. If you have exceptions to this format you can set it for each EDRC menu with the env EDRC command.

Example: NLS_DATE_FORMAT='MON DD YYYY HH24:MI:SS'

Default: NLS_DATE_FORMAT='MON DD YYYY HH24:MI:SS'


 
NLS_LANG
NLS language name. This name is exported to each recovery script. You should set your most used format here. If you have exceptions to this format you can set it for each EDRC menu with the env EDRC command.

Example: NLS_LANG=american

Default: NLS_LANG=american

TERM
Terminal emulation used. You should set this setting to the terminal you use the most. You can change the TERM setting using the term EDRC command for an edrc session.

Example: TERM=dtterm

Default: TERM=vt220

LOG
Log output dir of edrc. If you specify a relative path name the path is relative to the root of the WA2L/edrc installation.

Example: LOG=/var/opt/edrc/log

Default: LOG=var/log

LOGCOMPRESS
Compress logfiles of recovery scripts and contributed commands. If this setting is set to False the logfiles will not be compressed, if it is set to True the logfiles will be compressed after completion of the recovery script or contributed command. Using this setting you can save a significant amount of disk space. To view the logfile you can still use the log command or the logs contributed command within edrc without having to care if a log file is compressed or not. If you go to the edrc/var/log directory you can use zgrep(1) to grep the compressed logfiles.

Example: LOGCOMPRESS=True

Default: LOGCOMPRESS=False

LOGHEAD_OUTPUT
Output of the log header. If this setting is set to False the log header will only go to the logfile, if it is set to True it will go to the screen and to the logfile.

Example: LOGHEAD_OUTPUT=False

Default: LOGHEAD_OUTPUT=True

START_USER
This is the user edrc has to be started with.

Example: START_USER=eroot

Default: START_USER=root

DIST_HOSTLIST
Space separated list of hosts. To this hosts the files in SCRIPTS_BASEDIR will be distributed.

Example: DIST_HOSTLIST="acme045 acme014"

Default: -

DIST_USER
User used to distribute the files in SCRIPTS_BASEDIR. The home of this user is considered as the root of the WA2L/edrc installation. See edrcsetup(1m) for information about user settings needed by WA2L/edrc.

Example: DIST_USER=edrc

Default: DIST_USER=edrc

EDRC_OWNER
Owner of the WA2L/edrc software. This is the user the EDRC environment is installed with. See edrcsetup(1m) for information about user settings needed by WA2L/edrc.

Example: EDRC_OWNER=root

Default: EDRC_OWNER=root

DENY_LIST
Space separated list of functions/commands to be denied from invocation in EDRC. Be aware, that certain denials made here could be by-passed dependent of the operating system by the built in functionality of the more(1) and vi(1) commands used by EDRC internally. Be also aware, that potential sources of by-passing the denials are also the contributed commands, and of course the recovery scripts.

To minimize possible by-passes in contributed commands and in recovery script configurations (used in shared configurations with partly restricted rights) the is_permitted(3) command should be used to control command startup.

Currently the following denials are available: banner, browse, busy, clear, contrib, contrib.*, date, debug, distribute, edit_file, edrcdebug, edrcperm, env, env.edit, env.more, env.new, env.remove, env.view, erase, header, header.edit, header.more, header.new, header.remove, help, history, hostname, loadrec, log, log.grep, log.head, log.more, log.tail, log.view, man, menu, more_file, name, new_file, newmenu, newscript, PID, printrec, recoveryscript.*, remove_file, removemenu, removescript, renamemenu, renamescript, script, script.edit, script.more, script.start, script.view, setrec, shell, term, title, title.edit, title.more, title.new, title.remove, trunk, trunk.change, trunk.edit, trunk.follow, trunk.more, trunk.new, trunk.remove, trunkbypass, tty, tz, view_file.

Denials represented by a single word deny access to a command as a whole. If a denial consists of two words separated by a point, this will deny access to a sub function of a command. Denials containing an underscore deny access to low level functions that are used by many commands or command functions. Therefore if you like to deny any file editing in edrc you should add edit_file to the DENY_LIST instead of listing all <command>.edit denials.

Honestly, I could not imagine why to use many of those denials, but it gives you the maximal flexibility of configuration.

Example: DENY_LIST="newscript newmenu contrib.omnimon"

Default: DENY_LIST=""

DIST_MODE
Comma separated list of modes used to distribute the files in SCRIPTS_BASEDIR. The supported modes are: rtools which result in the use of rcp and rsh or OpenSSH which results in the use of scp and ssh for distribution. If a comma separated list is provided, the connection initiation is made in the sequence specified. A pseudo distribution mode is default which results in the use of the CONNECTION_MODE specified in the configuration files remote_shell.cfg and remote_copy.cfg. It is not allowed to specify default as part of a comma separated list.

Example: DIST_MODE=rtools,OpenSSH

Default: DIST_MODE=rtools

DIST_TYPE
Type of distribution. The supported types are: serial which results in a host by host distribution or parallel:max which results in a parallel distribution to multiple hosts. The max option specifies the maximal number of parallel distribution sessions.

Example: DIST_TYPE=parallel:20

Default: DIST_TYPE=serial

EDRC_OWNER
Owner of the WA2L/edrc software. This is the user the EDRC environment is installed with. See edrcsetup(1m) for information about user settings needed by WA2L/edrc.

Example: EDRC_OWNER=root

Default: EDRC_OWNER=root

EDRC_PROMPT
Prompt to be displayed before the @ symbol in edrc.

Example: EDRC_PROMPT=sysadmin

Default: EDRC_PROMPT=edrc

EDRC_HOSTPROMPT
With this setting it can be chosen, if the host name in the prompt that is displayed after the @ symbol in edrc is displayed in full length ( long ), or if only the host name part ( short ) is displayed.

Example: EDRC_HOSTPROMPT=short

Default: EDRC_HOSTPROMPT=long

BACKUP_DIR
This setting is used by scriptextract only. scriptextract saves all script files ahead of extracting (installing) the newly distributed scripts to this directory.

Example: BACKUP_DIR=/var/opt/edrc/backup

Default: BACKUP_DIR=var/backup

BACKUP_GENERATIONS
This setting is used by scriptextract only. Here the number of kept script backup versions can be specified. If this setting is set to 0, all versions will be kept and no backup purging will take place.

Based on experiences with systems having WA2L/edrc installed for about five years, the space needed to keep all script backup versions is not huge in average. Therefore this value can be set to a reasonable high value or to 0 without having bad feelings.

Example: BACKUP_GENERATIONS=200

Default: BACKUP_GENERATIONS=0

TMP_DIR
Specify the location of temporary files generated by edrc and scriptextract. It is only needed to change this setting from the default value if you experience filesystem fill ups on the default location. An alternate temporary directory has to have the identical permissions as the default location /tmp.

Example: TMP_DIR=/var/tmp

Default: TMP_DIR=/tmp

CONTRIB_MESSAGE
Normally ahead of executing a contributed command the message "edrc-INFO: starting contributed command 'example'" is printed. To switch this message off, change this setting from True to False.

Example: CONTRIB_MESSAGE=False

Default: CONTRIB_MESSAGE=True

NOTRECOGNIZED_MESSAGE
If this option is set to True the message "edrc-WARNING: 'example' is not recognized as a command or menu point." is printed if the user enters a command which is nether an internal/contributed command nor a menu point in the current recovery script menu. To switch this message off, change this setting from True to False.

Example: NOTRECOGNIZED_MESSAGE=True

Default: NOTRECOGNIZED_MESSAGE=False

RECOVERYPOINTINTIME_MESSAGE
If this option is set to True the message "edrc-WARNING: recovery point in time is *NOT* set!" is printed if the user starts a command and the recovery point in time is not set. It will not make sense to set this option to False in a disaster recovery script tree. However, if you use sat or an other configuration whose main purpose is not disaster recovery but system administration where you'll never use the "recovery point in time" it might be useful to not to print this message. To switch this message off, change this setting from True to False.

Example: RECOVERYPOINTINTIME_MESSAGE=False

Default: RECOVERYPOINTINTIME_MESSAGE=True

SETENVIRONMENT_MESSAGE
If this option is set to True the message "edrc-INFO: ahead of starting 'a:example' the environment defined in '_env' will be set" is printed if the user starts a command and an environment file exists for the current menue. It will not make sense to set this option to False in a disaster recovery script tree. However, if you use sat or an other configuration whose main purpose is not disaster recovery but system administration where you don't want to show ahead of each command start the message if an environment will be set it might be useful to not to print this message. To switch this message off, change this setting from True to False.

Example: SETENVIRONMENT_MESSAGE=False

Default: SETENVIRONMENT_MESSAGE=True

ABORT_MODE
Abort mode. This setting influences the abort behavior of edrc. If edrc receives the INT ( Ctrl+C ) or TERM ( kill ) signal the program will abort completely if ABORT_MODE = hard, edrc will only abort the current running script or command if ABORT_MODE = soft.

Example: ABORT_MODE=soft

Default: ABORT_MODE=hard

HISTORY_LENGTH
edrc saves every command you enter in a history. When you issue the history EDRC command a list of your last invoked commands is displayed. The length of this list can be configured with this option.

Example: HISTORY_LENGTH=20

Default: HISTORY_LENGTH=100

HISTORY_SEARCH
Number of history lines to e searched for a numbered command. The history is searched from the end to the beginning.

Example: HISTORY_SEARCH=200

Default: HISTORY_SEARCH=100

HISTORY_BROWSE
Control if the history can be accessed using the cursor keys and vi controls (j, k, /).

On systems with OSID=*Linux* the HISTORY_BROWSE is turned on (=True) by default (if the system supports it), on other OSIDs it's turned off.

Example: HISTORY_BROWSE=False

Default: HISTORY_BROWSE=True (for OSID *Linux*)

Default: HISTORY_BROWSE=False (for other OSID)

MAN_PATH
Additional man pages which are not available in the $MANPATH of the user defined in START_USER. This additional manpages will be appended to the current $MANPATH and are accessible thru the man command within EDRC. Do not add the man pages of EDRC to this path, those pages are available by default.

Note: This setting has become of minor importance. If all defined manual pages should be displayed in all edrc configurations identically, and also in man ( edrcman ), the manual page locations should be listed in the edrcman.cfg file.

Example: MAN_PATH=/opt/omni/man:/opt/apl/asystools/man

Default: MAN_PATH=-

 

SEE ALSO

edrc(1m), edrcintro(1), is_permitted(3), maketemp(3)

 

NOTES

-

 

BUGS

-

 

AUTHOR

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

 

COPYRIGHT

Copyright © 2013 Christian Walther

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.


 

Index

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

This document was created by man2html using the manual pages.
Time: 00:14:00 GMT, March 08, 2025