variable index (Marco’s Bash Functions Library)

Jump to:	A M S T

Jump to:	A M S T

1 Overview of the package
- 1.1 Quick run–time loading
- 1.2 Reliable run–time loading
- 1.3 Direct inclusion
- 1.4 Using the library interactively
- 1.5 Result variables
- 1.6 Notes
2 Using the script preprocessor
- 2.1 Invoking the preprocessor
- 2.2 Quotes and quoted macro names
- 2.3 Predefined symbols
- 2.4 Loading or including the library
- 2.5 Function parameters handling
- 2.6 Script arguments handling
- 2.7 Variable name references
- 2.8 Manipulating strings with macros
- 2.9 Manipulating arrays with macros
3 Required user defined variables
4 Some base functions
5 Encoding and decoding strings
6 Manipulating files and pathnames
- 6.1 File names
- 6.2 File Commands
- 6.3 Testing file existence and the like
- 6.4 Reading and writing files with privileges
- 6.5 Miscellaneous commands
7 Handling file descriptors
- 7.1 Opening file descriptors
- 7.2 Closing file descriptors
- 7.3 Duplicating file descriptors
- 7.4 Moving file descriptors
8 Selecting actions to perform
- 8.1 Introduction to action trees
- 8.2 Declaring actions and action sets
- 8.3 Dispatching action arguments
- 8.4 Inspecting action trees
- 8.5 Other functions
9 Parsing command line options
- 9.1 Arguments
- 9.2 Using the module
- 9.3 Predefined options
- 9.4 Interface functions
10 Printing messages to the console
- 10.1 Message module configuration
- 10.2 Printing plain messages
- 10.3 Printing formatted messages
11 Using external programs
- 11.1 Testing a script and running programs
- 11.2 Checking programs existence
- 11.3 Executing a program
- 11.4 Declaring the intention to use a program
12 Interfaces to external programs
- 12.1 Scheduling jobs for later execution
13 Catching signals
14 Manipulating strings
- 14.1 Quoted characters
- 14.2 Inspecting a string
- 14.3 Splitting a string
- 14.4 Converting between upper and lower case
- 14.5 Matching a string with a class
- 14.6 Comparing strings
- 14.7 Miscellaneous functions
15 Interacting with the user
16 Times and dates
- 16.1 Raw call to date
- 16.2 Acquire the current time and date
- 16.3 Special time and date formats
17 Manipulating variables
- 17.1 Manipulating arrays
- 17.2 Manipulating colon variables
- 17.3 Miscellaneous variable functions.
18 Manipulating arrays
19 Interfacing with the system
- 19.1 Reading and searching the file /etc/passwd
- 19.2 Reading and searching the file /etc/group
- 19.3 Converting file permissions
20 Running scripts at exit–time
21 Running location handlers
- 21.1 Single location, syntactic scoping
- 21.2 Nested locations
- 21.3 Nested function calls
22 Main function
- 22.1 Command line arguments variables
- 22.2 Driving script execution
- 22.3 Declaring exit codes
- 22.4 Other functions
23 Building test suites
- 23.1 A way to organise a test suite
- 23.2 A script to run tests
- 23.3 Configuring the package
- 23.4 Running test functions
- 23.5 Validating results by comparing
- 23.6 Validating results by output
- 23.7 Printing messages from test functions
- 23.8 Handling files in tests
Appendix A Examples for sending email
- A.1 How to compose a test email message
- A.2 Just send an email message
- A.3 Send email through a process in background
- A.4 Using gnutls-cli as connector
  - A.4.1 Immediate encrypted bridge
  - A.4.2 Delayed encrypted bridge
- A.5 Using openssl as connector
  - A.5.1 Immediate encrypted bridge
  - A.5.2 Delayed encrypted bridge
- A.6 Sending email
Appendix B GNU LESSER GENERAL PUBLIC LICENSE
Appendix C GNU Free Documentation License
Appendix D Bibliography and references
Appendix E An entry for each concept
Appendix F An entry for each function.
Appendix G An entry for each variable.

This document describes version 3.0.0-devel.0 of Marcos Bash Functions Library.

	Index Entry	Section

A
	`ARG1ST`:	main variables
	`ARGC`:	main variables
	`ARGC1`:	main variables
	`ARGV`:	main variables
	`ARGV1`:	main variables

M
	`mbfl_main_pending_EXIT_CODE`:	main exit
	`mbfl_main_SCRIPT_FUNCTION`:	main function
	`mbfl_program_BGPID`:	program executing
	`mbfl_split_PATH`:	program checking

S
	`script_AUTHOR`:	service variables
	`script_COPYRIGHT_YEARS`:	service variables
	`script_DESCRIPTION`:	service variables
	`script_EXAMPLES`:	service variables
	`script_LICENSE`:	service variables
	`script_PROGNAME`:	service variables
	`script_USAGE`:	service variables
	`script_VERSION`:	service variables
	`sendmail-mbfl-auth-info`:	sendmail script emacs vars
	`sendmail-mbfl-connector`:	sendmail script emacs vars
	`sendmail-mbfl-envelope-from-function`:	sendmail script emacs vars
	`sendmail-mbfl-envelope-to-function`:	sendmail script emacs vars
	`sendmail-mbfl-extra-args`:	sendmail script emacs vars
	`sendmail-mbfl-extract-addresses-function`:	sendmail script emacs vars
	`sendmail-mbfl-host-info`:	sendmail script emacs vars
	`sendmail-mbfl-hostname-function`:	sendmail script emacs vars
	`sendmail-mbfl-program`:	sendmail script emacs vars
	`sendmail-mbfl-timeout`:	sendmail script emacs vars
	`sendmail-mbfl-username-function`:	sendmail script emacs vars
	`SPLITCOUNT`:	strings splitting
	`SPLITFIELD`:	strings splitting

T
	`TESTMATCH`:	testing running
	`TESTSTART`:	testing running
	`TESTSUCCESS`:	testing running

Appendix G An entry for each variable.

Table of Contents