-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Upgrade app to 0.1.1 (automatic commit)
- Loading branch information
Showing
5 changed files
with
7 additions
and
627 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,151 +1,3 @@ | ||
| .\" man: Bash-Utils Manual | ||
| .\" man-name: bash-utils | ||
| .\" author: Pierre Cassat | ||
| .\" section: 1 | ||
| .\" date: 2016-04-27 | ||
| .\" version: 0.1.0 | ||
| .TH "bash-utils" "1" "2016-04-27" "Version 0.1.0" "Bash-Utils Manual" | ||
| .SH NAME | ||
| .TH "" "3" "" "" "" | ||
| .PP | ||
| Bash-Utils - A short \fIbash\fP library for better scripting. | ||
| .SH SYNOPSIS | ||
| .PP | ||
| Usage of the library as a script's interpreter: | ||
| .RS | ||
|
|
||
| .EX | ||
| #!/usr/bin/env bash-utils | ||
| .EE | ||
| .RE | ||
| .PP | ||
| Usage of the library in a script: | ||
| .RS | ||
|
|
||
| .EX | ||
| source bash-utils -- || { echo "> bash-utils not found!" >&2; exit 1; }; | ||
| .EE | ||
| .RE | ||
| .PP | ||
| Usage of the library as a command: | ||
| .PP | ||
| \fBbash-utils\fP [\fB-fhqvVx\fP] | ||
| [\fB--debug\fP|\fB--dry-run\fP|\fB--force\fP|\fB--help\fP|\fB--quiet\fP|\fB--verbose\fP|\fB--version\fP] | ||
| [\fB-e\fP|\fB--exec\fP[=\fIarg\fP]] <arguments> | ||
| .SH DESCRIPTION | ||
| .PP | ||
| The \fIBash-Utils\fP command is a small library of utilities to quickly write robust and complete \fIBash\fP scripts. | ||
| It proposes a set of useful functions and environment variables in an enhanced environment with some system | ||
| options enabled by default, to let you build a script with user options and arguments, an automatic generation | ||
| of some informational output about the script's usage, a special handling of errors, stack trace and debugging, | ||
| and some more features (see bash-utils(7) for a full documentation). | ||
| .PP | ||
| It also embeds a various set of \fImodules\fP constructed as stand-alone bash-utils scripts you can use "as-is", | ||
| calling them directly, or in a script using the library with the help of the `\fSrun()\fP` or `\fSuse()\fP` functions. | ||
| .SH OPTIONS | ||
| .SS Scripts using the library | ||
| .PP | ||
| The following options are supported by default for any script using the library: | ||
| .TP | ||
| \fI--dry-run\fP | ||
| Process a dry-run. | ||
| .TP | ||
| \fI-f\fP, \fI--force\fP | ||
| Force some commands to not prompt confirmation. | ||
| .TP | ||
| \fI-h\fP, \fI--help\fP | ||
| See the help information about the script, a module or the library itself. | ||
| .TP | ||
| \fI-q\fP, \fI--quiet\fP | ||
| Decrease script's verbosity. | ||
| .TP | ||
| \fI-v\fP, \fI--verbose\fP | ||
| Increase script's verbosity. | ||
| .TP | ||
| \fI-V\fP, \fI--version\fP | ||
| See the script, module or library version and copyright information ; | ||
| use option `\fS--quiet\fP` to get version number only. | ||
| .TP | ||
| \fI-x\fP, \fI--debug\fP | ||
| See some debugging information. | ||
| .PP | ||
| Please note that these options are available but not necessarily used in scripts or modules. | ||
| .SS Using the library as a command | ||
| .PP | ||
| The following additional options are available when you call the library itself: | ||
| .TP | ||
| \fI-e\fP, \fI--exec\fP [\fB=arg\fP] | ||
| Execute the argument in the library's environment ; as the argument is optional, the equal sign | ||
| is REQUIRED ; without argument, any piped content will be evaluated: | ||
| .br | ||
| bash-utils --exec='onoff_bit true' | ||
| .br | ||
| echo 'onoff_bit true' | bash-utils --exec | ||
| .br | ||
| .PP | ||
| The following additional arguments are available when you call the library itself: | ||
| .TP | ||
| \fIabout\fP | ||
| alias of '--version' | ||
| .TP | ||
| \fIabout module-name\fP | ||
| alias of 'module-name --version' | ||
| .TP | ||
| \fIhelp\fP | ||
| alias of '--help' | ||
| .TP | ||
| \fIhelp module-name\fP | ||
| get the help about a module | ||
| .TP | ||
| \fImodules\fP | ||
| get the list of available modules | ||
| .TP | ||
| \fIusage\fP | ||
| get the library synopsis | ||
| .TP | ||
| \fIusage module-name\fP | ||
| get a module synopsis | ||
| .TP | ||
| \fIversion\fP | ||
| alias of '--version --quiet' | ||
| .TP | ||
| \fIversion module-name\fP | ||
| alias of 'module-name --version --quiet' | ||
| .SH EXAMPLES | ||
| .PP | ||
| You can use the \fImodel\fP module to get a full example of a script using the library. | ||
| .RS | ||
|
|
||
| .EX | ||
| bash-utils model bash-utils | ||
| .EE | ||
| .RE | ||
| .PP | ||
| A starter template is available in bash-utils(7). | ||
| .SH LICENSE | ||
| .PP | ||
| Copyright (c) 2015, Pierre Cassat & contributors | ||
| .PP | ||
| Licensed under the Apache Software Foundation license, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| .PP | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| .PP | ||
| For the full copyright and license information, please view the LICENSE | ||
| file that was distributed with this source code or see | ||
| <http://www.apache.org/licenses/LICENSE-2.0>. | ||
| .SH BUGS | ||
| .PP | ||
| To transmit bugs, see <http://github.com/e-picas/bash-utils/issues>. | ||
| .SH AUTHOR | ||
| .PP | ||
| \fBBash-Utils\fP is created and maintained by Pierre Cassat (picas - <http://picas.fr/>) | ||
| & contributors. | ||
| .SH SEE ALSO | ||
| .PP | ||
| For documentation, sources & updates, see <http://github.com/e-picas/bash-utils.git>. | ||
| .PP | ||
| bash(1), bash-utils(7) | ||
| /Users/piwi/www/projects/piwi/bash-utilsman/MANPAGE.1.md |
Oops, something went wrong.