edrcintro

NAME

AVAILABILITY

DESCRIPTION

This manpage gives an overview over all commands and directories that are part of the WA2L/edrc package.

The command for the Enterprise Disaster Recovery Console, the interactive program to control a disaster recovery or also useful to simplify system administration tasks, is edrc. See edrc(1m) for a detail description of the console.

REVISION-HISTORY

COMMANDS

A

ansi2txt(3)

converts a stream of vt100 (ansi) codes on the stdin into readable text on the stdout. A file can be specified instead of stdin.

appendpdf(3)

Copy the contents of file2.pdf to the end of file1.pdf. The concatenated file is written to the specified output file or to stdout.

apply2file(1)

apply a data stream provided via pipe to a target file if the content differs from the target file. This is useful to edit files or to generate files which are system dependent.

Example:

  banner `hostname` |\
    apply2file -o -u root -g root -p 640 \
    -f /etc/issue

  cat /etc/rc.config.d/samba |\
    sed -e 's/RUN_SAMBA=.*/RUN_SAMBA=1/g' |\
    apply2file -o -f /etc/rc.config.d/samba

apply2sw_inventory(1)

apply a data stream to a software inventory file. See also swvi(1).

approot(3)

print installation root of WA2L/edrc.

apprevision(3)

print application revision of the WA2L/edrc package.

apropos(1)

search the whatis database for strings.

ascii(3)

This is not a command, but a documentation of ASCII character set encoded in octal, decimal, and hexadecimal.

asup(1)

application support configuration short start for edrc. See sat(1) for more information.

awk(1)

manual page of awk, pattern-directed scanning and processing language.

B

banner(3)

print big banner text as known from the login banners.

bash(1)

manual page of bash, GNU Bourne-Again SHell.

batteryalert(1)

monitor battery capacity and alert to all terminals on low charge.

binprobe(1m)

probe (compiled) executables and perl scripts if they are able to start on the current operating system.

bget(1)

basic tool to make HTTP GET requests and monitor the results.

busy(1)

print a rotating slash. This command does nothing productive. It might be useful to keep a line open when for instance a firewall cuts the connection if a TCP timeout is reached.

bwcreate(1m)

create a BarbedWire file that contains file properties and checksum of files on filesystems defined in the bwcreate.cfg(4) file. The BarbedWire file is used to track changes on (operating system) files.

bzcat(1)

decompresses .bz2 files to stdout.

bzdiff(1)

compare bzip2 compressed files.

bzgrep(1)

search possibly bzip2 compressed files for a regular expression

bunzip2(1)

unzip a block-sorting .bz2 file.

bzip2(1)

a block-sorting file compressor to generate .bz2 files.

bzip2recover(1)

recovers data from damaged bzip2 files.

bzmore(1)

file perusal filter for crt viewing of bzip2 compressed text.

C

catcomp(1)

cat a file out of a .tar.gz, .tgz or .cpio.gz file without decompressing the archive.

ccrypt(1)

ccrypt is a utility for encrypting and decrypting files and streams. It was designed to replace the standard unix crypt utility, which is notorious for using a very weak encryption algorithm. ccrypt is based on the Rijndael block cipher, which was also chosen by the U.S. government as the Advanced Encryption Standard (AES, see http://www.nist.gov/aes/). This cipher is believed to provide very strong cryptographic security.

cfg2html(1m)

This command creates a HTML (and ASCII) system documentation for HP-UX 10+11, AIX, SCO-UX, Solaris and Linux Systems. Plugins for SAP, Oracle, Informix, MC/SG, FibreChannel, TIP/ix, Mass Storage like XP48/256/512, Network Node Manager and OmniBack etc. are included. See also https://cfg2html.com/.

checkopt(3)

check list of used options matches against a table of allowed option combinations. This command is intended to be used to efficiently parse arguments in a script.

choice(3)

an interactive choice command for use in own recovery scripts and contributed commands.

cltrash(1)

perform cleanup tasks for files trashed with the trash command.

cmdlist(1m)

list all available commands in WA2L/edrc with some credentials, as: TYPE, location, operating system and start mode. See also compatibility(1).

cmmon(1m)

monitor of all MC/SG packages on HP-UX systems having MC/ServiceGuard installed. If an interval of 0 is specified a one time output is provided, else the output is continuously.

cmswitch(1m)

switch a MC/SG package to a node. Using this interactive command is much faster then entering all commands needed for a cluster package switch from one to an other node. You can restart a package if you specify the host where the package is currently running as the target node. Be aware that the cmswitch command does not check if it is possible to switch the package to the specified target node, therefore you should check the possible package switch positions first using the cmmon command.

compatibility(1)

This is not a command, but a documentation of the "WA2L/edrc command compatibility overview (compatibility matrix)" by Christian Walther.

connect(3)

connect is a proxy tool to enable OpenSSH and other TCP/IP utilities to run through SOCKS4/5 and HTTP proxy gateways. The arguments host and port are for the target hostname and port number to connect to.

consolidate(1)

filter to consolidate structured unix file content.

cpanm(1)

get, unpack build and install modules from CPAN. The cpanm command settings are tuned for the WA2L/edrc package and the Perl environment distributed with the package.

cpio(1)

copy file archives in and out; duplicate directory trees.

crfile(1)

create a dump file with a specific size.

crond(3)

daemon to execute scheduled commands. The crond integrated into WA2L/edrc allows to schedule jobs independent of the system.

To add/edit crontab(4) entries, use the ecrontab(1) command and to show the next scheduled commands ecronnext(1).

The crond(3) service is handled thru edrcinit(1m).

cronhandler(1)

handle cron and at jobs in a cluster environment. With cronhandler you can transfer crontab entries and even defined at jobs from one cluster node to an other depending on username. at jobs are time-adjusted if necessary.

crypt(1)

encrypt and decrypt files and streams. Note: the cipher used by Unix crypt has been broken and is not secure.

csv(3)

filter providing commands to process CSV data.

csvcat(3)

prepare and print a CSV file or stream for further processing.
Comment lines that begin with a hash ( # ) and empty lines are eliminated.
Lines that are distributed over multiple lines thru a backslash ( \ ) at the end of the line are joined.
White spaces before and after the field separator ( ; ) are eliminated.

csvq(3)

csvq is a command line tool to operate CSV files. You can read, update, delete CSV records with SQL-like query. You can also execute multiple operations sequentially in managed transactions by passing a procedure or using the interactive shell. In the multiple operations, you can use variables, cursors, temporary tables, and other features.

csv2worksheet(3)

load a CSV file (comma separated file) into an existing Excel spreadsheet. It is possible to load the data into an existing worksheet (tab) or to create a new worksheet if the worksheet with the name specified does not exist. This is an easy method to create "nice looking" Excel reports based on plain ASCII data without the need to create Excel makros or to develop complicated programs that create the whole Excel sheet. The idea is to load the data into a separate "data" worksheet (tab) and to perform the calculations, graphics, statistics etc. in a worksheet (tab) that is not touched by the data load. With this method it is even possible to create Excel reports directly on Unix systems without manual intervention.

D

daemon_wrapper(1)

start commands that run as daemons out of the edrc/lib/daemon directory.

days(3)

evaluate days since January 1st of a given date. If no date is specified the number of days from January 1st until the current date is printed ( this equals to date +%j on HP-UX systems ).

dbrep(1)

execute reports against an Oracle database.

dig(1)

send domain name query packets to name servers.

directories(3)

expand a file list data stream with the overlying directories.

Example:

  find /data/myApp -mtime 7 -print | directories |\
    cpio -pdvm /backup/myApp/20091212

dmidecode(3)

dmidecode is a tool for dumping a computer's DMI (some say SMBIOS) table contents in a human-readable format. This table contains a description of the system's hardware components, as well as other useful pieces of information such as serial numbers and BIOS revision. Thanks to this table, you can retrieve this information without having to probe for the actual hardware.

dos2ux(3)

convert ASCII file format between DOS and UNIX file format.

duvi(1)

edit the ..du_index file used by du_report to document your system.

du_report(1)

create a system report (with filesystems, directories, sizes and directory descriptions).

E

ecronnext(1)

show the commands that are scheduled next in the crontab(4) entries of the crond(3) bundled with WA2L/edrc.

ecrontab(1)

add/edit crontab(4) entries of the crond(3) bundled with WA2L/edrc.

edrc(1m)

this is the Enterprise Disaster Recovery Console. From here almost all recovery steps on UNIX can be performed.

edrcenv(1)

print the official WA2L/edrc environment variables.

edrcinit(1m)

handle services start/stop/restart, primarily for daemons included in WA2L/edrc, but other services can be handled as well. edrcinit supports to monitor and to restart a failed service based on the definitions made in the edrcinit.cfg config file.

edrclicense(4)

GNU General Public License for the WA2L/edrc package.

edrcman(1)

show manual pages of WA2L/edrc without the need to change the $MANPATH by hand.

edrcpack(1m)

depreciated, use pack(1m) to create a software package of the application.

edrcperm.no_shell(3)

pseudo shell to prevent shell exits within edrc possible in vi(1), view(1) and more(1) if the invocation of the functionality shell is denied with the related setting in DENY_LIST in the edrc.cfg file.

edrcports(4)

directory of network ports and protocols used by default by the WA2L/edrc package.

edrcrevision(1)

This is not a command, but a documentation of the "revision history of WA2L/edrc" by Christian Walther.

edrcroot(3)

print installation root of WA2L/edrc. This command is identical with approot and will be removed as soon as all commands within EDRC use approot to resolve the installation root.

edrcsetup(1m)

This is not a command, but a documentation of "How to install WA2L/edrc (Quick Installation Guide)" by Christian Walther.

envpasswdstrip(1)

strip passwords from _env files. This might be useful if you like to share recovery scripts but don`t like to hand out the passwords.

epub2pdf(1)

epub2pdf is a command-line tool that quickly generates PDF files from EPUB ebooks. It allows the user to specify page size, fonts, margins, and default paragraph alignment. See also http://epub2pdf.com/

eshell(1)

start shell. This command is located in the pbin/ directory to enable the user to conveniently start the shell command in his own user context.

eterm(1)

start edrc, asup, psup, shell etc. from pbin/ directory in a separate X-terminal window.

The eterm command also supports to create Desktop icons in the Gnome desktop environment.

This command is located in the pbin/ directory to enable the user to conveniently start it.

exiftool(1)

Read and write meta information in files. exiftool has been written by Phil Harvey. See also: http://www.sno.phy.queensu.ca/~phil/exiftool/

expect(3)

programmed dialog with interactive programs. expect is a program that "talks" to other interactive programs according to a script. Following the script, expect knows what can be expected from a program and what the correct response should be. An interpreted language provides branching and high-level control structures to direct the dialog. In addition, the user can take control and interact directly when desired, afterward returning control to the script.

F

fcreate(3)

create a file if it does not exist. Optionally text can be written to the file created. The intention of this command is to use it to create lock files within shell scripts.

fields2swvi(3)

convert a data stream to a correct swvi input sequence. fields2swvi is used by apply2sw_inventory internally. See also swvi(1) and apply2sw_inventory(1).

filedist(1)

distribute file(s) to a list of other systems.

filegrep(1)

grep for a pattern in all underlying ASCII files. Files located in a .sav directory or files saved with the sav(1) command are excluded from the search. See also scriptgrep(1).

filelink(1)

create hardlinks between identical files in two directory trees.

filesize(3)

print the size of a given file.

filewatch(3)

watch the file size progress of a given running command.

fit(3)

alias for fit2width(3).

fit2width(3)

fit a data stream to a certain width. This command can be used together with tty_columns to fit a stream to the current width of a terminal (tty).

fmatch(3)

prints the values of the given key from the file csv database specified on command line or in the $FMATCH_DATA_FILE environment variable.

fnmatch(3)

match a stream with a wildcard expression.

freespace(3)

print free space of the filesystem where the given directory is located on.

fssum(1)

summarize filesystems based on definitions in a configuration file. This command is used to create a filesystem summary grouped by product.

ftps(1)

secure FTP is an FTP program that allows for a secure connection to be made to an FTP server via a Secure Sockets Layer (SSL). This version of secure FTP supports both implicit and explicit SSL connections. See also http://www.glub.com/products/secureftp/

G

gawk(1)

manual page of gawk, GNU Project's implementation of the AWK programming language.

gecos(3)

return the GECOS (=comment) field of a defined user account.

getfilesystem(3)

print the file system where the current working directory is related to.

gethostbyname(1)

host lookup using gethostbyname() system call. This tool is useful to check if your /etc/nsswitch.conf works properly.

getmountpoint(3)

print the mount point where the current working directory is related to.

gid(3)

return the group-id (GID) of an existing group.

glibc.version(3)

print version number of the glibc library.

group(3)

return the group name of an existing group for a given group-id.

gs(3)

The gs command invokes Ghostscript, an interpreter of Adobe Systems' PostScript™ and Portable Document Format (PDF) languages.

gs reads "files" in sequence and executes them as Ghostscript programs. After doing this, it reads further input from the standard input stream (normally the keyboard), interpreting each line separately and output to an output device (may be a file or an X11 window preview, see below).

The interpreter exits gracefully when it encounters the quit command (either in a file or from the keyboard), at end-of-file, or at an interrupt signal (such as Control-C at the keyboard).

gunzip(1)

compress or expand files.

gzip(1)

compress or expand files.

H

h2(1)

H2 is a relational database management system written in Java. It can be embedded in Java applications or run in the client-server mode. The disk footprint (size of the jar file) is about 1.5 MB.

histlist(3)

print a table of history files including the resolution of usage begin, usage end, history file size and history file name.
The begin can be resolved properly only if the history file names comply to the history file names as produced by the shell(1) command when started outside edrc.

homedir(3)

return the homedir of a user.

hostaliases(3)

return aliases for a given host.

hostlist(3)

return a hostlist. This command is used to centralize the configuration of a list of hosts to a single configfile.

hostlistdat2cfg(3)

convert a hostlist.dat file that has the structure

Example:

  #
  # Format:
  #
  #   <CUSTOMER>;<ENVIRONMENT>;<GROUPS>;<OPTIONS>;<HOSTS>
  #
  ACME;DEVELOPMENT   ;@APP  ;;host-001 host-002;
  ACME;DEVELOPMENT   ;@DB   ;;host-003;
  ACME;TEST          ;@APP  ;;host-101 host-103;
  ACME;PREPRODUCTION ;@APP  ;;host-201 host-202 host-205;
  ACME;PRODUCTION    ;@APP  ;;host-303 host-308 host-309;

into settings that can be used in the hostlist.cfg file.

This command will significantly simplify the definition of host lists of large environments and will make the more complicated constructs obsolete where using the fmatch(3) command in the hostlist.cfg(4) configuration file.

Despite the many options that the hostlistdat2cfg provides, normally only the -m and the -o options will be used in the hostlist.cfg config file. See also samples in the edrc/var/samples/hostlist directory.

html2mht(3)

convert a HTML file to a single web archive file (MHT) that can be viewed using for instance the Microsoft Internet Explorer (TM) or an other MHT viewer. html2mht is currently able to convert local HTML files having the image files locally stored. CSS and JavaScripts have to be within the HTML file to get a good result when viewing the converted file.

hwinventory(1)

command to print a minimal set of inventory information needed for asset management.

I

ident(3)

continuous output of characters received via stdin with a leading ident on each line. This command is depreciated, use indent(3) for new scripts.

indent(3)

continuous output of characters received via stdin with a leading ident on each line.

info(1)

read Info documents.

ini(1)

initialize the environment based on named definitions specified in etc/env. Each shell has its own ini.<shell> binary to initialize the environment based on the definitions. So it is not necessary to use different syntax for different shells, this is done by the ini.<shell> command. The interactive ini command is a shell alias pointing to the relating ini.<shell> command. The alias in the ksh shell therefore calls the ini.ksh command, a C-shell would call the ini.csh command.

input(3)

an interactive input command for use in own recovery scripts and contributed commands.

input_targets(3)

special purpose input to query lists of hosts. The prompt cannot be changed an is set to "Target hosts". The input and the optional command argument is a space separated list of hosts and hostgroups. If the input differs from the default the input prompt is repeated to allow verification and corrections. If no target_list is specified in input_targets target_list the default target list provided in the input prompt is as it is resolved by hostlist(3).

ipcalc(1)

ipcalc takes an IP address and netmask and calculates the resulting broadcast, network, Cisco wildcard mask, and host range. By giving a second netmask, you can design subnets and supernets.

ipsort(1)

with this command you can sort a data stream which has IP addresses in the first column.

is_config_byhand(3)

evaluate if a given file is listed in a config_byhand file. If so return 'True' else return 'False'. This command can be used in pre_exec and post_exec scripts within sysconfig.

is_existing(3)

check if a file/directory/link etc. is existing and accessible by the calling user. This command does not hang if for instance the NFS resource where the file/directory/link is located is not available. There is the possibility to specify a timeout value when the default of 0 second is not sufficient.

is_osid(3)

evaluate if the operating system id returned by osid(3) matches to one os-id specified by the -o option. This command is used to limit a script execution to supported operating systems only.

Example:

  is_osid -s $0 -o HP-11,Solaris || exit $?

is_permitted(3)

the main intention of this command is to check if a certain functionality is permitted for execution in contributed commands. In recovery scripts global functionality and script functionality can be checked for startup permission. This enables you to minimize possible by-passes of the denials defined in the DENY_LIST in the edrc config file edrc.cfg(4) when you use an edrc configuration for system management purposes.

is_running(3)

evaluate if a given cluster package is up. Return 'True' if it is up, otherwise return nothing, therefore this command can be used in crontab to run a certain line only if the specified cluster package is running on this host.

Example:

  0 1 * * * [ "`/opt/edrc/lib/is_running psoftprod`" ] \
    && /opt/psoft/bin/my_command

is_up(3)

evaluate if a system is up thru pinging it with a one second timeout.

is_user(3)

evaluate if the user that started the command matches to one username specified by the -u option. This command is used to limit a script execution to supported users only.

is_weekend(3)

return True if the current day is at the weekend, else return False.

is_writeable(3)

check if write access to a file or a directory is possible. Return 'True'/'0' if write access is possible, otherwise return 'False'/'1'.

J

java(1)

start java based on the setting in java_wrapper.cfg. The java command is started thru the .java_wrapper.

java_wrapper(1)

wrap programs written in java that they can be started the same way at it would be native commands. The search order to the java command installed on the system or eventually distributed with WA2L/edrc has to be set in the configuration file java_wrapper.cfg if it is not found.

job(1)

job sequencer. This command can be used to serialize jobs on a UNIX system. It has a similar user interface to the at command. The advantages of this command are multiple queue support, execution of jobs in the current user environment and a logging facility.

joblog(1)

monitor the logfile of the job command.

jobstart(1)

start jobs using a simple interface, where a job is identified by a JOBNAME.

jobwatch(1)

monitor the state of jobs in a certain queue. The output is similar to the top command.

jq(3)

jq is a lightweight and flexible command-line JSON processor.

See https://stedolan.github.io/jq/manual/ and https://stedolan.github.io/jq/tutorial/ for more information.

K

kalc(1)

kalc is a programmable scientific calculator, using RPN (Reverse Polish Notation). It includes over 200 functions and a built-in help system. kalc works with real numbers, complex numbers and also integers in other numeric bases. Its has a complete programming language, with control-flow structures such as if and while. It has "unlimited" memory for you to store objects.

ksh(1)

manual page of ksh, KornShell, a standard/restricted command and programming language.

kshell(1)

print path of the Korn- or Bourne Again shell available on the system.

ksh_wrapper(1)

wrap Korn- and Bourne Again shell scripts to avoid using #!/bin/ksh in the magic key. However, due to the fact that some scripts need Korn shell functionality either ksh or bash has to be installed in /bin, /sbin, /usr/contrib/bin or /usr/local/bin.

L

lbanner(3)

print a ASCII banner as the banner(3) command does, but allow more options, as character size, fill character and banner orientation.

lcat(1)

alias for logcat(1).

leo(1)

leo is a command line interface to the german/english/french/spanish/... dictionary on http://dict.leo.org/. It supports almost all features which the website supports, plus more. Results will be printed to the terminal. By default the searched key word will be highlighted. leo has been written by Thomas Linden <tom@daemon.de>. See also: http://search.cpan.org/~tlinden/

lgcheckd(1m)

a daemon to check logfiles for patterns and to create a consolidated findings report.

This is the more efficient and leaner variant of the logcheckd(1m) daemon command that operates on the same configuration file format, the same pattern files and interfaces as logcheckd(1m) for easy migration.

lgcpattern(3)

check/analyse/verify a logcheckd.pattern(4) file definition against a data stream.

This utility helps to create the definitions in a pattern file.

lgrep(1)

alias for loggrep(1).

listtemp(3)

list temporary directories created with maketemp(3) and resolve if the related process that created the temp dir is still running. This command can be used for system housekeeping.

ll(1)

long file listing. This command calls internally ls -laF [ options ] and is to enable the user to use ll when calling rcmd even on operating systems where ll(1) is not provided.

llcomp(1)

detailed list of the contents of a compressed tar archive ( .tar.gz, .tgz or .cpio.gz files) without decompressing it.

locate(1)

search for pattern in the locate database produced by updatedb(1m).

locations(1)

print a list of corporate locations with local time.

log(3)

write a log message to the logfile for use in contributed commands.

logcat(1)

cat selected time range (from/to) in log files having time stamps. To grep selected time range (from/to) in log files having time stamps use the loggrep(1) command.

logcheckd(1m)

a daemon to check logfiles for patterns and to create a consolidated findings report. The report can be mailed to a list of recipients.

See also the new log checking daemon lgcheckd(1m).

logcut(1)

shorten logfiles to a number of rows.

loggrep(1)

grep selected time range (from/to) in log files having time stamps.

logrotate(1)

rotate logfiles and preserve a number of old logfiles.

logtail(1)

give a selection of common logfiles, which can be listed in $HOME/.mylog_files, $HOME/.log_files or in etc/log_files.cfg and start tail -f <selected_file> .

logview(1)

give a selection of common logfiles, which can be listed in $HOME/.mylog_files, $HOME/.log_files or in etc/log_files.cfg and start view <selected_file> .

lots(1m)

long term data save handling.

lotsctl(1)

lots control menu configuration short start for edrc. lotsctl provides an easy to use user interface to the lots(1m) command. In addition to the lots(1m) command, some reporting functionality is provided. See sat(1) for more information.

lscomp(1)

list the contents of a compressed tar archive ( .tar.gz, .tgz or .cpio.gz files) without decompressing it.

lscp(1)

print a list of cp commands with files in the current working directory to the screen. This might be useful if you have to copy files and adjust the filenames of many recovery scripts.

Example:

  lscp > a; vi a; sh a; rm a

lsmv(1)

print a list of mv commands with files in the current working directory to the screen. This might be useful if you have to adjust filenames of many recovery scripts.

Example:

  lsmv > a; vi a; sh a; rm a

lsof(1)

list open files.

lspm(1)

list installed perl modules including version an installation path. See also pmdesc(1).

lua(1)

lua is the standalone Lua interpreter. It loads and executes Lua programs, either in textual source form or in precompiled binary form. lua can be used as a batch interpreter and also interactively.

luac(1)

luac is the Lua compiler. It translates programs written in the Lua programming language into binary files containing precompiled chunks that can be later loaded and executed.

luaenv(3)

print the environment used by lua to access the Lua modules bundled with WA2L/edrc. To set the environment prior to execution of lua, invoke:

  eval `luaenv` 

luarocks(1)

start the luarocks command with settings tuned for the WA2L/edrc package and the Lua environment distributed with the package.

See also https://luarocks.org/ and https://github.com/luarocks/luarocks/blob/main/docs/index.md for additional information.

luaversion(3)

print the major.minor version of lua3.

lua_wrapper(1)

wrap Lua scripts and programs to avoid using #!/usr/bin/lua or similar path names in the magic key. This enhances the portability of WA2L/edrc commands written in Lua to systems where Lua is not installed in the default install locations. lua has to be installed in edrc/bin/, /bin/, /sbin/, /usr/bin/, /usr/local/bin/ or /usr/contrib/bin/. Further lua locations can be configured in the optional config file

lynx(1)

Lynx is a fully-featured World Wide Web (WWW) client for users running cursor-addressable, charactercell display devices (e.g., vt100 terminals, vt100 emulators running on Windows 95/NT or Macintoshes, or any other "curses-oriented" display). It will display hypertext markup language (HTML) documents containing links to files residing on the local system, as well as files residing on remote systems running Gopher, HTTP, FTP, WAIS, and NNTP servers.

M

mail_file(1)

send a mail with a message content and file attachment(s).

maketemp(3)

create a unique non existing temporary directory with secure permissions. Use removetemp(3) to remove a temporary directory created with maketemp.

makeuser(1)

user friendly interface to mkuser.

mandir(4)

This is not a command, but a documentation of a "directory of manual page online resources" compiled by Christian Walther.

man2html(3)

converts a manual page as found in file (or stdin, in case no file argument, or the argument -, is given) from man-style nroff into HTML, and prints the result on stdout.

manvi(1)

edit manual pages in WA2L/edrc. It is possible to specify additional directories to be searched for manual pages in the configuration file manvi.cfg.

mc(1)

GNU Midnight Commander is a directory browser/file manager for Unix like operating systems. If the environment variable $MCTERM is not set, the terminal emulation is set to xterm, what is fine for most cases.

mcedit(1)

Internal file editor of GNU Midnight Commander. If the environment variable $MCTERM is not set, the terminal emulation is set to xterm, what is fine for most cases.

mcview(1)

Internal file viewer of GNU Midnight Commander. If the environment variable $MCTERM is not set, the terminal emulation is set to xterm, what is fine for most cases.

md2html(3)

convert markdown file to HTML.

md5string(3)

calculate MD5 checksums for strings line by line.

mediawiki(3)

get/put MediaWiki pages from/to a MediaWiki server. The communication does not need the MediaWiki API ( api.php ), therefore also MediaWiki servers running on older versions then 1.13 are supported.

mkuser(3)

create and initialize a new directory for a user.

msg(3)

write a message to the screen for use in own recovery scripts and contributed commands.

msmtp(3)

an SMTP client as an alternative to sendmail(8).

N

name(1)

print description of a file or directory examined from the file header.

nano(1)

Nano's ANOther editor, an enhanced free Pico clone. nano is a small, free and friendly editor which aims to replace Pico, the default editor included in the non-free Pine package. Rather than just copying Pico's look and feel, nano also implements some missing (or disabled by default) features in Pico, such as "search and replace" and "go to line and column number". nano is included mainly into WA2L/edrc due to the possibility to run it in restricted mode ( -R, or as rnano ) and in a real viewer mode ( -v ) without the possibility of bypassing it, as view does allow with the :w! command.

Example use of nano in recovery scripts:

as normal editor:

  nano $file >`tty`

as editor with the restriction to edit only the given file:

  rnano $file >`tty`

as a real read only viewer only allowing to view the given file:

  rnano -v $file >`tty`

nc(3)

nc is a simple Unix utility which reads and writes data across network connections, using TCP or UDP protocol.

nginx(3)

a HTTP and reverse proxy server, mail proxy server. nginx (pronounced engine-x for its high performance, stability, rich feature set, simple configuration, and low resource consumption.

nmap(1)

nmap (Network Mapper) is an open source tool for network exploration and security auditing. It was designed to rapidly scan large networks, although it works fine against single hosts. nmap uses raw IP packets in novel ways to determine what hosts are available on the network, what services (application name and version) those hosts are offering, what operating systems (and OS versions) they are running, what type of packet filters/firewalls are in use, and dozens of other characteristics. While Nmap is commonly used for security audits, many systems and network administrators find it useful for routine tasks such as network inventory, managing service upgrade schedules, and monitoring host or service uptime.

nologin(1)

nologin shell to block users from login in to the system.

nping(1)

nping is an open-source tool for network packet generation, response analysis and response time measurement. nping allows users to generate network packets of a wide range of protocols, letting them tune virtually any field of the protocol headers. While nping can be used as a simple ping utility to detect active hosts, it can also be used as a raw packet generator for network stack stress tests, ARP poisoning, Denial of Service attacks, route tracing, and other purposes.

O

omniutil(1m)

a collection of OmniBack (OBII) enhancement utilities.

os_wrapper(1)

wrap os dependent binaries to allow transparent shellscript programming.

osid(3)

evaluate the systems operating system id.

osid.probe(3)

library command to probe if the setting in osid.dat is compatible to the related compiled binaries in bin/OSID/ and lib/OSID/.

osup(1)

operation support configuration short start for edrc. See sat(1) for more information.

outex(1)

produce output of a selected logfile (without path) that is saved in edrc/var/log/ that can be used in contrib.doc(1m) in the OUTPUT-EXAMPLE section.

The intension is to use the outex logfile command directly from within vi when editing a recovery script, as:

  # D: Restore database. 
  #
  ~
  ~
  ~
  :. !outex 2020-06-02_10.52.05__db_restore.log

This will include the contents of the logfile edrc/var/log/2020-06-02_10.52.05__db_restore.log (without logfile header) into the vi session. Each line will be prepended by the # O: documentation tag.

The specified logfile can also be a gzipped file, as: 2020-06-02_10.52.05__db_restore.log.gz

Furthermore if the specified logfile 2020-06-02_10.52.05__db_restore.log does not exist, but the 2020-06-02_10.52.05__db_restore.log.gz does, the contents of the compressed file is included and vice versa.

P

pack(1m)

create a shell archive ( example: edrc-1.4.08-200502150919.sh ) of WA2L/edrc that can be used to install WA2L/edrc on all supported operating systems. Logfiles, backup files, lock files etc. are excluded from the package.

passwdcombine(1)

combine password files or password databases. This is useful if you have to apply a new set of users to a system and you like to prevent a change of certain users (as system users).

passwdsort(1)

sort a passwd file or data stream from stdin by UID.

passwdsyncd(1m)

a daemon to synchronize passwords over several systems. The daemon can be switched centrally to a maintenance mode. While in maintenance mode the synchronizations on all nodes taking part on a synchronization is on hold. The behavior of passwdsyncd can be configured in passwdsyncd.cfg.

passwdsyncd_apply(3)

apply passwords distributed with passwdsyncd to the target system.

patchinstall(1m)

patch an WA2L/edrc installation. patchinstall also cleans up corpses of older WA2L/edrc versions. All patched files and cleaned up corpses are backed up.

pdfmetaedit(1)

GUI to edit meta data of a PDF file. This command was developed by "zarrro". See also http://zaro.github.io/pdf-metadata-editor/.

pdfscissors(1)

GUI to crop PDF file for eBook reader. This command was developed by Abdullah Al Mazed (Gagan). See also http://pdfscissors.com/.

perlenv(3)

print the environment used by perl to access the Perl modules bundled with WA2L/edrc. To set the environment prior to execution of perl, invoke:

  eval `perlenv` 

See also perl_modules(3) for additional information.

perlversion(3)

print perl version of perl interpreter found on the system. See also perl_wrapper (3) for additional information.

perl_wrapper(1)

wrap Perl scripts to avoid using #!/usr/bin/perl or similar path names in the magic key. This enhances the portability of WA2L/edrc commands written in Perl to systems where perl is not installed in the default install locations. perl has to be installed in /bin, /sbin, /usr/local/bin or /usr/contrib/bin. Further perl locations can be configured in the config file perl_wrapper.cfg.

pf_wrapper(1)

Wrap WA2L/edrc commands to be started thru pfexec(1) or sudo(8).

To use the commands in pbin/ add the directory to the user's $PATH variable:

  [ /home/fred ]
  [ fred@host-001 ][bash]: vi ~/.bashrc
     :
    27  # Add edrc/pbin to $PATH
    28  PATH=~edrc/pbin:$PATH; export PATH
   ~
   ~

pip(1)

start the pip command pip3(1) with settings tuned for the WA2L/edrc package and the Python3 virtual environment (venv) distributed with the package.

pip3(1)

the pip command is the Python package manager. The pip command call within WA2L/edrc handles the virtual environment venv distributed with WA2L/edrc.

pid(1)

select (grep) a given pattern out of the process list.

pkgdir(1m)

This is not a command, but a documentation of a "directory of package/software handling commands" compiled by Christian Walther.

pkg_hostname(3)

return MC/ServiceGuard package name the current working directory is related to. If the directory is not related to a package the hostname is returned. This command can be used to set the user's prompt depending on the path the user is currently in.

pkzip(1)

compression utility.

pl(1)

pl is a program that produces plots and charts from data, and produces results that can be viewed on web pages, paper, slides, or interactively on the screen. A user developed script file may be supplied for greater flexibility and customization. pl may be executed from the command line or as a CGI program.

pmdesc(3)

List name, version, and description of all installed perl modules and PODs. See also lspm(1).

pod2html(3)

Converts files from POD (Plain Old Documentation) format to HTML format. See also: https://perldoc.perl.org/perlpod and perlpod(4).

portscan(3)

scan a target system for active ports. It is possible to specify the minimum port where the scan should start and the maximum port number where the scan should stop. Ports that are active are returned to stdout.

print_header(3)

print a standard report header to the terminal. The output is limited to the current terminal width if the environment variable $PRINT_FIT2WIDTH is not set to False.

print_index(3)

print a standard report column index to the terminal. The output is limited to the current terminal width if the environment variable $PRINT_FIT2WIDTH is not set to False.

Example:

  cat<<EOM | print_index
  ZIP;Postal Zip Code
  CITY;Name of the City
  STATE;State
  CNT;Country Shortcut
  COUNTRY; Country Full Name
  EOM

  COLUMN INDEX:

  ZIP ...... Postal Zip Code     CNT ...... Country Shortcut
  CITY ..... Name of the City    COUNTRY .. Country Full Name
  STATE .... State

print_list(3)

the intention of this command is to print a list to a terminal in a good readable format. A csv file provided via pipe is printed to stdout. The first row is treated as header row. The width of all columns is dynamically adjusted to the row with containing the longest entry. Furthermore the output is limited to the current terminal width if the environment variable $PRINT_FIT2WIDTH is not set to False. To select named columns prior to print the list with print_list use select_columns(3).

Example 1:

  cat<<EOM | print_list
  ZIP;CITY;STATE;CNT;COUNTRY
  93117;Goleta;CA;USA;United States of America
  8222;Beringen;SH;CH;Switzerland
  8005;Cape Town;WC;RSA;South Africa
  EOM

  ZIP    CITY       STATE  CNT  COUNTRY
  -----  ---------  -----  ---  ------------------------
  93117  Goleta     CA     USA  United States of America
   8222  Beringen   SH     CH   Switzerland
   8005  Cape Town  WC     RSA  South Africa
  (3)

Example 2:

  cat<<EOM | select_columns ";" "CNT;ZIP;CITY" | print_list
  ZIP;CITY;STATE;CNT;COUNTRY
  93117;Goleta;CA;USA;United States of America
  8222;Beringen;SH;CH;Switzerland
  8005;Cape Town;WC;RSA;South Africa
  EOM

  CNT  ZIP    CITY
  ---  -----  ---------
  USA  93117  Goleta
  CH    8222  Beringen
  RSA   8005  Cape Town
  (3)

pscount(3)

count processes and evaluate if the situation correlates to a defined situation as received thru stdin.
This command is intended to be used to check if the correct number of needed processes for an application are running on the system.

Example:

  cat << EOM | pscount
  1; 1;Oracle Listener ;oracle;.+/tnslsnr LISTENER .+;
  1;10;Oracle DB Writer;oracle;ora_dbw[0-9]_ACMEDB;
  1;  ;Oracle Connects ;oracle;oracleACMEDB .+;
  EOM

  DESCRIPTION       MIN  MAX  CURRENT  STATE
  ----------------  ---  ---  -------  -----
  Oracle Listener     1    1        1  OK
  Oracle DB Writer    1   10        2  OK
  Oracle Connects     1             0  FAIL
   *TOTAL*            3   11        3  FAIL
  (4)

psjoin(3)

join concatenates several PostScript files and generate a single PostScript document. The output, concatenated PostScript document, will be written to the standard output.

The input PostScript files must comply with the DSC (Document Structuring Convention). psjoin can fail to work depends to the input PostScript file or combination of the input PostScript files.

pslist(3)

list and select processes in a cross operating system compatible format. When not invoked with the -l (= long output) option, only a list of the process-ids of the selected processes is printed.

ps2pdf(3)

convert PostScript files to PDF.

pstree(1)

print a process tree.

psup(1)

production support configuration short start for edrc . See sat(1) for more information.

purgetemp(3)

remove all temporary directories in a base dir that where created by maketemp(3) and have the state IS_ACTIVE=False.

pwcrypt(1)

encrypt a plain password.

pwsafe(3)

this command that can be called from outside of edrc(1m) 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 contrib.edrc(1m), contrib.pwsafe(1m) and pwsafe(3) for more information.

pythonenv(3)

print the environment used by python to access the Python modules bundled with WA2L/edrc. To set the environment prior to execution of python3, invoke:

  eval `pythonenv` 

pythonversion(3)

print the major.minor version of python3.

python_wrapper(1)

wrap Python scripts to avoid using #!/usr/bin/python3 or similar path names in the magic key. This enhances the portability of WA2L/edrc commands written in Python to systems where Python is not installed in the default install locations. python3 has to be installed in /bin, /sbin, /usr/bin, /usr/local/bin or /usr/contrib/bin. Further python locations can be configured in the optional config file python_wrapper.cfg.

R

random(3)

return a random number or a random item of a specified item list.

rcat(1)

display (cat) remote- or local file(s).

rcomm(1)

compare (comm) remote- or local file(s).

rcmd(1)

run a command or a set of commands on a set of hosts. You can specify the command(s) in the command line, if you don`t you are prompted for it.

rdiff(1)

show differences (diff) of remote- or local file(s).

readline(3)

read long input lines from stdin and return the input to stdout. The maximum length of the input is 10240 characters (10 kBytes), input longer then this maximum is ignored and truncated.

regexintro(4)

This is not a command, but a documentation that gives an "Introduction to Regular Expression Usage" compiled by Christian Walther.

resolve_targetlist(3)

resolve a targetlist which may consist of a list of hosts and hostgroups.

rel2abs(3)

convert a relative filename to an absolute.

remote_copy(3)

wrapper for remote copies. This command enables you to write scripts independent of the current security policy of your systems. Internally remote_copy uses rcp or scp dependent of the configuration settings. Furthermore this command provides a caching mechanism which remembers successful connection modes to speed up future connections.

remote_shell(3)

wrapper for remote shells. This command enables you to write scripts independent of the current security policy of your systems. Internally remote_shell uses remsh, rsh or ssh dependent of the configuration settings. Furthermore this command provides a caching mechanism which remembers successful connection modes to speed up future connections.

removetemp(3)

remove a temporary directory created with maketemp(3).

repeat(3)

the repeat command re-executes the single subsequent command for count number of times.

revision(1)

print the most recent revision entry of a file examined from the file header.

rl(1)

shortcut for the rlogin command. See rlogin(1) manpage for additional information.

rnano(1)

Restricted mode for Nano's ANOther editor ( nano ), an enhanced free Pico clone. rnano is a restricted version of nano, which only edits specific files and doesn't allow the user access to the filesystem or a command shell. See example usage in intro of nano above.

role_option(3)

return the value of a certain option related to a role in an environment. This function is used to support a role based user creation model based on role templates which can be defined in the relating configuration file role_option.cfg.

rosid(3)

evaluate the systems operating system id of a remote system.

rsat(1)

start sat on a remote system. The list of hosts provided can be specified in the configuration file rsat.cfg.

rssh(1)

connect to a remote system using ssh(1).

When invoking the rssh command the remote user and the remote host is queried interactively, where the last chosen user- and host-name is provided as default input.

When a symlink to the rssh command in the format rssh-user@host is created, the newly created command variant will connect directly to the host with the user and the remote system will query for the password.

The main purpose for this is to create a pseudo user (without password) and add the command variant rssh-user@host to the shell field of the /etc/password field to allow to use a local system to be used as a direct terminal to a remote system, as for example:

  acme:x:1291:1291:acme login terminal:/tmp:/home/fred/bin/rssh-fred@acme

This would allow you to enter acme as login on the local system that will connect to the remote host where the login password of the user will be queried.

rsync(1)

rsync is a program that behaves in much the same way that rcp does, but has many more options and uses the rsync remote-update protocol to greatly speed up file transfers when the destination file is being updated.

S

sat(1)

short start of edrc with an other configuration which points to an own script tree. Internally sat calls edrc -c edrc.sat.cfg . sat stands for "system administration tool". If additional short starts are needed, create a symlink from the new short start command to sat.

Example:

  cd ~edrc/bin
  ln -s sat new_shortstart

When starting new_shortstart interally edrc -c edrc.new_shortstart.cfg will be called.

Currently the following short start commands are distributed with WA2L/edrc: asup (Application Support Configuration), psup (Production Support Configuration), osup (Operation Support Configuration), lotsctl (Long Term data Save Control Configuration).

sav(1)

save a file to a backup with preserving the filepermissions and file dates.

screen(1)

screen is a full-screen window manager that multiplexes a physical terminal between several processes (typically interactive shells). Each virtual terminal provides the functions of a DEC VT100 terminal and, in addition, several control functions from the ISO 6429 (ECMA 48, ANSI X3.64) and ISO 2022 standards (e.g. insert/delete line and support for multiple character sets). There is a scroll-back history buffer for each virtual terminal and a copy-and-paste mechanism that allows moving text regions between windows.

scriptextract(3)

extract scripts distributed with the distribute EDRC command.

scriptgrep(1)

grep all recovery scripts for a pattern. Files in .sav directories and files not following the name convention *:* are excluded from the search. See also filegrep(1).

scriptheadersync(1)

synchronize the header entries in recovery scripts with the actual filename of the script. The script starts in the current working directory and searches all underlying directories for recovery scripts matching the filename convention: <menupoint>:<scriptname>.

scriptmenupath(3)

return recovery script menu path when called from a recovery script or _env file in the form 'menu -> submenu -> subsubmenu -> menupoint'.

scriptrevision(3)

print the revision number of a (script)file following the [##] revision notation as also resolved by revision(1).

scriptsequence(3)

check if recovery scripts are called in ascending sequence. If not a message is printed or the script is aborted. scriptsequence must be called from a recovery script or _env file to give the user more awareness if the sequence is broken.

Usage example (query to abort or not):

  scriptsequence || exit

Usage example (inform only):

  scriptsequence -a inform || exit

scripttitle(3)

print recovery script title (menupoint, description and duration as defined in doc tag) when called from a recovery script or _env file to give the user more awareness which menu point is started.

seconds(3)

calculate seconds since the Epoch for a given date and time. Use timer to evaluate the seconds since the Epoch for the current moment.

sectioncat(3)

cat section ( [SECTION] ) of a text file.

sed1line(1)

This is not a command, but a documentation of "USEFUL ONE-LINE SCRIPTS FOR SED (Unix stream editor)" compiled by Eric Pemet.

select_columns(3)

filter to select named columns that are separated by a field separator from stdin and print the selected columns to stdout. The first row of the data stream must contain the row header. Columns that do not exist, are printed as empty columns.

Example:

  cat<<EOM | select_columns ";" "CNT;ZIP;CITY"
  ZIP;CITY;STATE;CNT;COUNTRY
  93117;Goleta;CA;USA;United States of America
  8222;Beringen;SH;CH;Switzerland
  8005;Cape Town;WC;RSA;South Africa
  EOM

  CNT;ZIP;CITY;
  USA;93117;Goleta;
  CH;8222;Beringen;
  RSA;8222;Cape Town;

server_environment(3)

return a name for the environment of the server where running the command. In the configuration file server_environment.cfg it can be defined which server relates to what environment. The server_environment command can be used to develop scripts which act specific on different environments without hardcoding hostnames into the scripts.

Example:

  case `server_environment` in
    TEST)
          Max_load=100
          Mail_to=fred.developer@acme.com
          ;;
    PREPRODUCTION)
          Max_load=200
          Mail_to=barney.verifier@acme.com
          ;;
    PRODUCTION)
          Max_load=250
          Mail_to=wilma.production@acme.com
          ;;
    unknown)
          echo "server environment unknown, aborting."
          exit 1
          ;;
  esac

sh(1)

manual page of sh, command interpreter (shell).

shell(1)

the shell command provides a slightly reduced environment as the shell command started within edrc. The differences to the shell start in edrc is, that the environment variables $EDRC_SESSION, $EDRC_SCRIPTS_BASEDIR, $EDRC_ENV, $EDRC_CONFIGFILE, $EDRC_RECOVERYTIME, $EDRC_DIST_USER, $EDRC_NLS_DATE_FORMAT, $EDRC_NLS_LANG, $NLS_DATE_FORMAT and $NLS_LANG are not set. Call the edrcenv(1) command to display the official WA2L/edrc environment variables.

shellinaboxd(3)

publish command line shell through AJAX web interface.

In WA2L/edrc the shellinaboxd server process is configured in the edrc/etc/shellinaboxd.cfg configuration file and started thru edrcinit(1m). Use the command:

  edrcinit start shellinaboxd

to start the shell web server process.

In the default configuration, the user then can connect to the address https://servername:8806 and work with the command line shell thru the web browser without the need of installing a terminal emulation program locally. A connect to http://servername:8806 is redirected to the https address.

See also: http://code.google.com/p/shellinabox/ and http://www.tecmint.com/shell-in-a-box-a-web-based-ssh-terminal-to-access-remote-linux-servers/.

shlib(3)

print the environment variables needed by the dynamic linker ld(1) to locate the shared libraries. If a script need to set this environment variables ( $LD_LIBRARY_PATH and $SHLIB_PATH ), use

  eval `shlib`

instead of setting them by your own. This ensures, that all scripts will continue to run, even when the directory structure in WA2L/edrc changes.

sortc(3)

sorting data in the "C" locale. Internally the sort(1) command is called.

sortv(3)

Provide a version sort functionality as provided by the sort -V command to operating systems, where sort(1) lacks this functionality.

sparse(3)

filter to identify sparse files. The filelist received thru stdin is searched for sparse files and the file names of all identified sparse files, or all non-sparse file names ( -v ), are printed to stdout. This enables to use the output directly for further processing thru a pipe for instance.

Examples:

Find sparse files in the current directory:

  find . -print | sparse

Copy all sparse files:

  find . -print | sparse | cpio -pdvm --sparse /destination

Copy all non-sparse files:

  find . -print | sparse -v | cpio -pdvm /destination

splitvt(1)

This program splits the screen into two windows, one above the other, and runs a shell in each one.

ssh-exec(1)

execute commands provided thru stdin on a remote system using ssh.

Example:

  ssh-exec -u fred -t acme-007 <<EOC
  date
  uptime
  uname -a
  EOC

ssh-exec also supports to remote control commands using expect(3) without the need to write whole expect "wrapper" scripts or without even writing expect code.

ssh-keyadd(1m)

Add SSH public keys to a users (normally root's) authorized_key file(s). Furthermore the SSH daemon configuration file is modified that way that it is allowed to connect as root. To make the configuration change active, the HUP signal is sent to the SSH daemon.

sshpass(1)

sshpass is a utility designed for running ssh using the mode referred to as "keyboard-interactive" password authentication, but in non-interactive mode.

sqlite(1)

SQLite is a software library that implements a self-contained, serverless, zero-configuration, transactional SQL database engine.
SQLite is the most widely deployed SQL database engine in the world. It is used in countless desktop computer applications as well as consumer electronic devices including cellphones, PDAs, and MP3 players. The source code for SQLite is in the public domain. See http://www.sqlite.org/docsrc for more information.

stat(1)

This command returns the file status information returned by the stat(2) system call.

To print the modification time in a consistent format use

  timer `stat -s mtime -f my_file`

The advantage of using this command instead of

  ls -al my_file

is, that the output format does not change over time, as the ls does.

strace(1)

trace system calls on Linux. This command is called internally, if the truss command is invoked on Linux.

streamcat(3)

continuous unbuffered output of an input stream received thru stdin to stdout.

svi(1)

edit the file in a sysconfig repository which is related to the local (active) file on the system. This command is equal to the sysvi command.

sw_report(1)

create a software inventory report of a system. This command takes the ..sw_inventory files as a base for information.

swvi(1)

edit the ..sw_inventory file used by sw_report to create a software inventory of your system.

symlink(1)

create a symbolic link. In addition to the ln -s command symlink removes an existing symbolic link or file with the same name prior to the symbolic link creation. If the -l option is specified symlink only proceeds if the file is an existing symbolic link; the intention of this option is to use symlink to switch an existing symbolic link from one to another target.

sys(1)

System configuration handling and some automated EDRC tasks, as WA2L/edrc package distribution and patch installation. See sys(1) for more information.

sysconfig(1)

configure a system with a prepared set of files with a single command.

sysinfo(1)

prints information on overall system statistics. If called with an option to specify a dedicated information, the current time, the number of seconds since the Epoch and the relating information is printed separated by a deliminator on a single line. The main intention of the command was to print the system uptime in a more computable fashion ( sysinfo -u ) then returned by the uptime command.

syscp(1)

copy an (active) file on the system to the related sysconfig repository.

sysdiff(1)

list if an (active) file on the system applied with sysconfig differs to the file(s) in the related repository. The files are considered as different if the content or the filepermissions differ. To obtain a plain list of files that differ from the applied file, redirect the output to stderr.

syspoll(1)

poll systems and execute a query. The main purpose is to centrally control report data collection.

sysvi(1)

edit the file in a sysconfig repository which is related to the local (active) file on the system. This command is equal to the svi command.

sys2html(1m)

create a 'System Configuration' HTML report similar to cfg2html(1m) from remote systems without the need to install it on the systems where the configuration shall be collected.

T

tcpdump(1)

dump traffic on a network.

textblock(3)

format a stream into a justified text block with an optional hanging first line.

textcolor(3)

set the terminal text color. The ATTRIBUTE option can be set to RESET, BRIGHT, DIM, UNDERLINE, BLINK, REVERSE or HIDDEN. The FOREGROUND and BACKGROUND options can be set to BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN or WHITE.

thttpd(3)

thttpd is a simple, small, fast, and secure HTTP server.

timer(1)

return the number of seconds since the Epoch or return the date based on the given number of seconds since the Epoch. Use seconds to evaluate the number of seconds for a specific date.

timezone(3)

return the timezone as set in the timezone.cfg file or as defined system wide.

title(1)

set the title of the terminal window. There are two predefined titles that can be chosen using the short or long option. It is also possible to define an own title text.

today(3)

return the date of today. It is also possible to specify the format of the return value as known from the date(1) command. This command can be substituted directly by date and does exist, to have an equivalent command to tomorrow(3) and yesterday(3) returning the value in the identical format.

tolower(3)

return a given string in lowercase.

tomorrow(3)

return the date of tomorrow. It is also possible to specify the format of the return value as known from the date(1) command.

top(1)

displays the top processes on the system and periodically updates the information. Raw CPU percentage is used to rank the processes.

toupper(3)

return a given string in uppercase.

tpl(1)

select and print a template file to stdout.

tput_examples(3)

examples on the use of the tput(1) command to control terminal outputs.

traceroute(1m)

print the route packets take to network host.

trash(1)

remove file(s) and create a <filename>.TRASHED file that contains information about the removal and the possibility of a restore of the file.

truss(1)

truss traces the system calls a process invokes and the signals it receives. It displays arguments in a symbolic way, shows the first bytes of read and write buffers as well as signal information when available. tusc can attach to live processes by providing PIDs (process IDs) as argument(s).

tscat(3)

filter to add a timestamp and a filename to a stream.

tsize(3)

this command returns the current width and height of the terminal in the COLUMNS and LINES variables. This output can be used directly to initialize the environment variables using the eval command:

  eval `tsize`

The output of tsize is identical to the resize(1) command as provided when X11 is installed. As long as resize is available on the system it is used internally to resolve the terminal size, if not, a fallback exists to evaluate the terminal without the use of resize. Therefore it is not imperative to have X11 installed on the system when using tsize to resolve the terminal size.

ttyplay(1)

player of the tty session recorded by ttyrec(1).

ttyrec(1)

a tty recorder.

ttytime(1)

print the time of the recorded session data by ttyrec(1).

tty_columns(3)

return the current width of the terminal (tty).

tty_variable(3)

return the current value of a terminal (tty) setting.

tzdump(3)

dump the contents of a zoneinfo file.

U

uid(3)

return the user-id (UID) of an existing user.

uncbz(1)

unpack b2zipped cpio file(s) to the current directory. The source file remains packed.

uncbz2(1)

unpack b2zipped cpio file(s) to the current directory. The source file remains packed.

uncgz(1)

unpack gzipped cpio file(s) to the current directory. The source file remains packed.

unczip(1)

unpack zipped cpio file(s) to the current directory. The source file remains packed.

unczst(1)

unpack zstd-compressed cpio file(s) to the current directory. The source file remains packed.

unczstd(1)

unpack zstd-compressed cpio file(s) to the current directory. The source file remains packed.

undeb(1)

unpack file(s) of a rpm file(s) to the current directory. The source file remains packed.

uniqpath(3)

removes duplicate entries in a colon separated string without changing the field order. This command can be used to tidy up $PATH, $MANPATH or $USAGE_PATH settings.

unrpm(1)

unpack file(s) of a rpm file(s) to the current directory. The source file remains packed.

untbz(1)

unpack b2zipped tar file(s) to the current directory. The source file remains packed.

untbz2(1)

unpack b2zipped tar file(s) to the current directory. The source file remains packed.

untgz(1)

unpack gzipped tar file(s) to the current directory. The source file remains packed.

untrash(1)

restore file(s) removed by trash.

untxz(1)

unpack xz-ed tar file(s) to the current directory. The source file remains packed.

untzst(1)

unpack zstd-compressed tar file(s) to the current directory. The source file remains packed.

untzstd(1)

unpack zstd-compressed tar file(s) to the current directory. The source file remains packed.

unzip(1)

unzip will list, test, or extract files from a ZIP archive, commonly found on MS-DOS systems.

unzstd(1)

expand files.

updatedb(1m)

create the locate database to be queried by locate(1).

usage(1)

print a short usage of non standard commands available in WA2L/edrc.

user(3)

return the user name of an existing user for a given user-id.

user_info(1)

print information of a user defined on the system. This is an interface to read with one command in a structured matter from several files which are needed to finally define a user on a Unix/Linux system (passwd, group, samba user map, ftpusers, trusted system settings where applicable, ...).

uudecode(1)

uudecode transforms uuencoded files into their original form.

uuencode(1)

uuencode is used to create an ASCII representation of a file that can be sent over channels that may otherwise corrupt the data. Specifically, email cannot handle binary data and will often even insert a character when the six character sequence "0rom " is seen.

ux2dos(3)

convert ASCII file format between UNIX and DOS file format.

V

vadsp(1)

display additional information of a VA-7410 of HP on HP Unix systems attached to a VirtualArray.

vcat(1), vmore(1), vdiff(1), vgrep(1), vlist(1), vpurge(1), vrestore(1), vsav(1)

the v(sav|cat|more|diff|grep|list|purge|restore) commands enable to save, print, compare, grep, list, purge and restore versions of a given file.

vsdfml(3)

very simple document formatting language. The main purpose is to highlight documentation files on terminal output when writing recovery scripts whose purpose is to display only information and not to execute commands. To benefit from vsdfml you have to add it to the magic key of your information "recovery script": #!/bin/sh vsdfml. Lines starting with a hash ( # ) are considered as comments and are not printed. Repetitive empty lines are reduced to one line.

vvi(1)

versioned file editor using vi(1) respectively the editor set in $EDITOR.

Prior to editing the given files each file is saved using vsav(1).

W

watchdog(1)

a watchdog to check a certain condition. If the checked condition matches, bite.

wa2lc(3)

directory of additional C include files provided in the WA2L/edrc package.

wa2ledrc_edrcapi(1)

web application WA2L/edrc:edrcapi (EDRC REST API) to serve WA2L/edrc information in API fashion.

wa2ledrc_report(1)

web application WA2L/edrc:report (OPERATING SYSTEM REPORT PORTAL) to serve mainly static operating system reports that are saved in a simple directory structure ( <Customer>/<Report_Name>/<Report_file> ). A main goal is to provide a web interface without the need of extensive configuration. However, a user administration web interface is included.

The portal can be provided for a single customer e.g. when running directly in the customer's environment, or for a consolidated multiple customer view for system administration personnel.

wa2ledrc_shellinaboxd(1)

web application WA2L/edrc:shellinaboxd to serve WA2L/edrc command line over Web browser.

wget(1)

GNU Wget is a free utility for non-interactive download of files from the Web. It supports HTTP, HTTPS, and FTP protocols, as well as retrieval through HTTP proxies.

whatis(1)

search the whatis database for complete words.

whereami(1)

print the server environment where logged on. In addition the structured user definition information of the current user is printed.

whoisin(1)

print a list of users who are logged in on certain (remote) hosts.

wmic(1)

client to use the Windows Management Instrumentation from Linux.

winexe(1)

client to execute commands remotely on Windows from Linux.

woist(1)

search a path for a file.

X

xbdf(1m)

a platform independent version of the bdf respectively df -k command. Line breaks are removed, as experienced on HP-UX in certain circumstances.

xlog(1)

write date from stdin to a logfile. Each line is preceded with a date, time, sequence and tag entry. A common use might be in crontab instead of piping outputs to /dev/null.

Example:

  a_command 2>&1 | xlog -t a_cmd -f /var/adm/log/a_command.log

xml2csv(3)

convert XML schema to CSV.

xml2json(3)

convert XML schema to JSON.

xmore(1)

display file(s) page by page in WA2L/edrc recovery scripts. The more(1) or less(1) command do not stop for user input after displaying a page if used in a recovery scripts.

xpid(1)

select processes from the process command part of the process list. This is a convenience command to the pslist(1) command.

Internally the xpid command calls currently pslist -l -c '.*selection.*' .

The xpid command is intended for manual command line use only, for script use the pslist command should be used because the output of the xpid command is not intended for further processing and might be changed.

xtee(1)

an enhanced version of the standard tee command. This one appends the standard output with extra data and session columns to the logfile. It is planned to use this command by edrc internally to save the standard output of the recovery scripts to the logfiles.

Y

yesterday(3)

return the date of yesterday. It is also possible to specify the format of the return value as known from the date(1) command.

ypxfr_all(1)

transfer NIS maps from a NIS master server.

Z

zcat(1)

zcat is identical to gzip -c.

zdiff(1)

compare compressed files.

zgrep(1)

search possibly compressed files for a regular expression.

zip(1)

zip is a compression and file packaging utility for Unix, VMS, MSDOS, OS/2, Windows NT, Minix, Atari and Macintosh, Amiga and Acorn RISC OS.

zless(1)

file perusal filter for crt viewing of compressed text.

zmore(1)

file perusal filter for crt viewing of compressed text.

zstd(1)

compress or expand files.

FILES

The name(1) command can be used to list a short description of files and directories.

.ssh

DO NOT SAVE *ANY* DATA INTO THIS DIRECTORY.

This directory contains *no* ssh keys, ssh authorized key files or ssh configuration files. The ssh files are saved in the var/connection/ structure. See below for more information.

The reason why this directory exists is, that on certain operating systems under special conditions (as HPUX 11.11 having the random number generator patch not installed), the connection in OpenSSH mode fails when using the commands rcmd, filedist, remote_copy, remote_shell or when establishing trunks in edrc.

pbin/

binary directory for commands that could be started with elevated permissions. This directory only contains symlinks to the .pf_wrapper. See pf_wrapper(1) for additional information.

sbin/

this is the location of the edrc command. This directory should not be included in $PATH.

bin/

some general use commands. This directory is in $PATH.

bin/<OSID>/

operating system dependent commands. This commands are mostly compiled for the designated operating system. The command call occurs via the os_wrapper command and never via a $PATH enhancement or a direct call.

contrib/edrc/

contributed commands to edrc. Do not change the edrc program if you miss a general command. Create the command in this directory and you will be able to invoke it as it is an edrc internal command. This will protect you from loosing your work after an upgrade of edrc and will keep the edrc command itself stable.

doc/

some printable documentation, including all man pages, in PDF, PostScript and HTML format.

etc/

configuration files

lib/

commands which are mostly used within scripts. Some of them require some environment settings. This directory in in $PATH.

lib/<OSID>/

operating system dependent library commands. This commands are mostly compiled for the designated operating system. The command call occurs via the os_wrapper command and never via a $PATH enhancement or a direct call.

lib/<OSID>/libs/

shared libraries needed by the compiled operating system dependent commands located in bin/<OSID>/ and lib/<OSID>/ started thru the os_wrapper. The os_wrapper(3) ensures that this directory is added to the $LD_LIBRARY_PATH and the $SHLIB_PATH.

lib/daemon/

Korn shell scripts called via daemon_wrapper(1).

lib/dbrep/

SQL reports used by dbrep(1).

lib/edrc/

library functions called by the edrc(1m) command.

lib/icons/

icon images.

lib/java/

location of Java .class, .jar, .class.javaopt and .jar.javaopt files. The Java programs are called via the java_wrapper(1). Therefore when calling java commands in WA2L/edrc this is transparent to the user and the command can be called by simply entering my_command my_options, there is no need to call java java_options my_command my_options as it is normally the case. Using the java_wrapper(1) there is no need to write a start script for each Java program. If a certain Java program needs special options passed to java, those options can be specified in the config file lib/java/filename.class.javaopt or lib/java/filename.jar.javaopt with the JAVA_OPTIONS setting.

lib/ksh/

Korn shell scripts called via ksh_wrapper(1). In WA2L/edrc Korn shell scripts are not executed via the magic key #!/bin/ksh due to the fact that this is less portable then Bourne shell scripts. Shell locations can be configured in the configuration file ksh_wrapper.cfg.

lib/logcheckd/

files used by the logcheckd(1m) when generating LogCheck reports.

lib/lua/

Lua scripts called via lua_wrapper(1).

lib/lua/lum/

additional Lua modules used by the Lua scripts/programs started thru the lua_wrapper(1).

lib/pack/

library functions used by pack(1m).

lib/perl/

Perl scripts called via perl_wrapper(1). In WA2L/edrc Perl scripts are not executed via the magic key #!/usr/bin/perl due to the fact that this startup is dependent on the installation directory of perl(1), which is not necessarily identical on all systems where WA2L/edrc is installed.

lib/perl/pm/

additional Perl modules used by the Perl scripts started thru the perl_wrapper(3).

lib/ploticus/

files read by the ploticus command pl(1), especially when using the -prefab option.

lib/python/

Python scripts called via python_wrapper(1).

lib/python/pym/

additional Python modules used by the Python scripts started thru the python_wrapper(1).

man/

manual pages. See edrcman(1) and manpages(4) for an explanation of the organization of the manual pages.

scripts/

here are all recovery scripts stored by default. The content of this directory has to be customized to your environment. For a description how to write recovery scripts for EDRC see edrcscripts(1m).

scripts/sys/

Pre-configured "Recovery" script tree:
System Configuration handling scripts, including some automated EDRC tasks as a simple EDRC patch installation. The EDRC configuration file edrc.sys.cfg points to this directory.

scripts/unknown-edrc/, scripts/unknown-sat/, scripts/unknown-sat/sup:Support/*sup:*Support/

Dummy "Recovery" script trees that are shown when invoking edrc, sat, asup, osup and psup when the Customer in the server_environment.cfg configuration file cannot be resolved. Therefore, if the edrc, sat, asup, osup or psup commands load one of those trees, you need to set the entries in the server_environment.cfg properly.

scripts/<Customer>-edrc/

Disaster Recovery script tree to be created for disaster recovery for the <Customer> where the system belongs to. The <Customer> has to be set identical to the value returned by the server_environment -C command.
The default EDRC configuration file edrc.cfg points to this directory and is used if you invoke the edrc command without options.

scripts/<Customer>-sat/

Script tree to be created for System Administration to automate common tasks for the <Customer> where the system belongs to. The <Customer> has to be set identical to the value returned by the server_environment -C command.
The default EDRC configuration file edrc.sat.cfg points to this directory and is used if you invoke the sat command.

scripts/<Customer>-sat/sup:Support/asup:ApplicationSupport/

Script tree to be created for Application Support to automate common application operation support tasks for the <Customer> where the system belongs to. The <Customer> has to be set identical to the value returned by the server_environment -C command.
The EDRC configuration file edrc.asup.cfg points to this directory and is used if you invoke the asup command.

The edrc.asup.cfg configures less permissions (editing of menus and menu points etc.) for it's users. Because it is a sub-directory of the sat menu tree, it can nevertheless be managed centrally by the user of the sat command.

scripts/<Customer>-sat/sup:Support/osup:OperationSupport/

Script tree to be created for Operation Support to automate common operation support tasks for the <Customer> where the system belongs to. The <Customer> has to be set identical to the value returned by the server_environment -C command.
The EDRC configuration file edrc.osup.cfg points to this directory and is used if you invoke the asup command.

The edrc.osup.cfg configures less permissions (editing of menus and menu points etc.) for it's users. Because it is a sub-directory of the sat menu tree, it can nevertheless be managed centrally by the user of the sat command.

scripts/<Customer>-sat/sup:Support/psup:ProductionSupport/

Script tree to be created for Production Support to automate common production support tasks for the <Customer> where the system belongs to. The <Customer> has to be set identical to the value returned by the server_environment -C command.
The EDRC configuration file edrc.psup.cfg points to this directory and is used if you invoke the asup command.

The edrc.psup.cfg configures less permissions (editing of menus and menu points etc.) for it's users. Because it is a sub-directory of the sat menu tree, it can nevertheless be managed centrally by the user of the sat command.

.sav

backup directory in a recovery script tree. Whenever a file in edrc is edited or removed a backup copy is automatically saved into the .sav directory of the current menu (=subdir). Therefore, if you like to restore a file to a prior version, invoke the shell command in edrc, change to the .sav directory and restore the desired file using the normal operating system commands.

src/

source code of certain programs.

var/

var directory of WA2L/edrc.

var/backup/

several backups.

var/barbedwire/

bwcreate(1m) cache information.

var/cache/

cache base directory.

var/cache/<command>/

cache directory for a certain <command>.

var/connection/

this directory holds connection and security information used for connections to other hosts. See edrc.cfg(4) for more information about the currently possible DIST_MODE settings and edrc(1m), remote_copy(3) and remote_shell(3) for a more detailed description of the var/connection directory.

var/contrib/edrc/

var directory for contributed commands to edrc. See edrc(1m) for information how to use this directory.

var/csv2worksheet/

template spreadsheet files for the csv2worksheet(1m) command.

var/dns/<dns-server>/

var directory of DNS server(s) bundled with the WA2L/edrc package.

var/edrcinit/

persistent data of edrcinit(1m).

var/fonts/

additional fonts.

var/locate/

databases for the locate(1) command.

var/lock/

lockfiles. Do not edit them by hand.

var/log/

all logfiles of the EDRC environment. Here the logfile of edrc and the output of all recovery scripts is saved. Therefore customizing scripts don't have to implement an own logging mechanism. All output sent to stdout will be saved in a designated logfile.

var/logcheckd/

collect, report, state and pattern information used and written by the logcheckd(1m) command.

var/lots/

default var directory of lots(1m).

var/makeuser/classes/

this directory contains example user classes files used by makeuser.

var/manvi/

manual page templates for manvi(1).

var/notes/

free text notes. The contents of this directory is excluded from the package.

var/omniutil/pd/

this directory contains the OBII Oracle pointer directory structure templates.

var/pack/

state information for pack. Do not edit it by hand.

var/passwdsyncd/

default spool directory for the password sync daemon passwdsyncd.

var/pscount/

process reference information used by the pscount(3) command.

var/repl/

this directory is used to save scripts replicated with the distribute EDRC command.

var/samples/

this directory contains configuration samples for reference and inspiration.

var/settings/

persistent settings.

var/shell/

here the shell history of the interactive shell built in to edrc and the history of edrc are kept.

var/spool/

spool directories for crond(3).

var/sw/

directory to pack(1m) the WA2L/edrc package to or to store delivered WA2L/edrc patches. The content of this directory is excluded from packing.

var/sysconfig/development.acme.com/

in this directory a template directory structure used for sysconfig is saved.

var/tmp/

temporary files to be kept within the application.

var/trash/

default 'Recycle Bin' directory for trash and the related commands.

var/vsav/

directory to save versions of a file by vsav and related commands to it.

var/www/

web files for thttpd(3) web server.

SEE ALSO

NOTES

Special thanks to Reimund Mueller (EDS, Information Business GmbH, Switzerland), who acted as editor of the "1 / Allgemein" part of the "Emergency Handbook" in his leisure time.

The WA2L/edrc package came into being during a disaster recovery project realized for an insurance company in Switzerland in 2003. A huge portion of the WA2L/edrc package has been developed by the author Christian Walther <wa2l@users.sourceforge.net> in his leisure time.

Now in 2023 the WA2L/edrc has a lifespan of 20 years; it turns out that it is still useful for new disaster recovery solutions and system administration simplification.

The source of the commands sav(1), homedir(3), mkuser(3), woist(1) and pid(1) is the SFI-Director. The following commands were inspired by the SFI-Director: osid(3), nologin(1) and sysconfig(1). The SFI-Director, was an excellent (GPL) toolset for managing NIS and NIS++, distributing software over several Unix/Linux flavors, central user profile management, configuring and documenting systems and much more developed by Peter Stevens. Unlike many other script based tools all commands were realized as very reliable and stable shell scripts and demonstrated by example that it is possible to implement reliable and portable applications as shell scripts. All commands and files of the SFI Director were well documented. The sources of the script based SFI-Director are no longer available online.

Check out other WA2L projects on Sourceforge: https://sourceforge.net/u/wa2l/profile/.

LICENSE

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

A copy of the GNU General Public License is distributed with WA2L/edrc and is saved in edrc/doc/COPYING.

Check on Sourceforge (http://sourceforge.net/projects/wa2l-edrc/) for the most recent version of the WA2L/edrc package.

BUGS

AUTHOR