mirror of
https://github.com/kvz/bash3boilerplate.git
synced 2024-12-18 22:27:51 +00:00
Kevin van Zonneveld
commit
9be08bb692
64
FAQ.md
Normal file
64
FAQ.md
Normal file
@ -0,0 +1,64 @@
|
||||
[This document is formatted with GitHub-Flavored Markdown. ]:#
|
||||
[For better viewing, including hyperlinks, read it online at ]:#
|
||||
[https://github.com/kvz/bash3boilerplate/blob/master/FAQ.md ]:#
|
||||
|
||||
# Frequently Asked Questions
|
||||
|
||||
## Contents
|
||||
* [What is a cli](#what-is-a-cli)?
|
||||
* [How do I add a command-line flag](#how-do-i-add-a-command-line-flag)?
|
||||
* [How do I access the value of a command-line argument](#how-do-i-access-the-value-of-a-command-line-argument)?
|
||||
* [How do I incorporate bash3boilerplate into my own project](#how-do-i-incorporate-bash3boilerplate-into-my-own-project)?
|
||||
* [What is a magic variable](#what-is-a-magic-variable)?
|
||||
* [How do I incorporate bash3boilerplate into my own project](how-do-i-incorporate-bash3boilerplate-into-my-own-project)?
|
||||
* [How can I contribute to this project](how-can-i-contribute-to-this-project)?
|
||||
|
||||
### What is a cli?
|
||||
|
||||
A 'cli' is a [command-line interface](https://en.wikipedia.org/wiki/Command-line_interface).
|
||||
|
||||
### How do I incorporate bash3boilerplate into my own project?
|
||||
|
||||
You can incorporate bash3boilerplate into your project one of three ways:
|
||||
1. Copy the desired portions of [main.sh](./main.sh) into your own script.
|
||||
2. Copy [main.sh](./main.sh) into the same directory as your script and then edit and embed it into your script using bash's dot (".") include feature, e.g.
|
||||
#!/bin/bash
|
||||
. main.sh
|
||||
3. Source [main.sh](./main.sh) in your script or at the command line
|
||||
source main.sh
|
||||
4. ... (add additional use cases here and descriptions of how to use other files in bash3boilerplate)
|
||||
|
||||
### How do I add a command-line flag?
|
||||
|
||||
1. Copy the line the main.sh [read block](https://github.com/kvz/bash3boilerplate/blob/master/main.sh#L53) that most resembles the desired behavior and paste the line into the same block.
|
||||
2. Edit the single-character (e.g., -d) and, if present, the multi-character (e.g., --debug) versions of the flag in the copied line.
|
||||
3. Omit the "[arg]" text in the copied line if the desired flag takes no arguments.
|
||||
4. Omit or edit the text after "Default:" to set or not set default values, respectively.
|
||||
5. Omit the "Required." text if the flag is optional.
|
||||
|
||||
### How do I access the value of a command-line argument?
|
||||
|
||||
To evaluate the value of an argument, append the corresponding single-character flag to the text "$arg_". For example, if the [read block]
|
||||
contains the line
|
||||
```bash
|
||||
-t --temp [arg] Location of tempfile. Default="/tmp/bar"
|
||||
```
|
||||
then you can evalute the correspondign argument and assign it to a variable as follows:
|
||||
```bash
|
||||
temp_file_name=$arg_t
|
||||
```
|
||||
|
||||
### What is a magic variable?
|
||||
|
||||
The [magic variables](https://github.com/kvz/bash3boilerplate/blob/master/main.sh#L63) in main.sh are special in that...
|
||||
|
||||
### How do I submit an issue report?
|
||||
|
||||
Please visit our [Issues](https://github.com/kvz/bash3boilerplate/issues) page.
|
||||
|
||||
### How can I contribute to this project?
|
||||
|
||||
Please fork this repository. Then create a branch containing your suggested changes and submit a pull request based on the master branch
|
||||
of https://github.com/kvz/bash3boilerplate/.
|
||||
|
||||
|
||||
30
README.md
30
README.md
@ -1,6 +1,22 @@
|
||||
<!-- badges/ -->
|
||||
[](https://travis-ci.org/kvz/bash3boilerplate)
|
||||
<!-- /badges -->
|
||||
[This document is formatted with GitHub-Flavored Markdown. ]:#
|
||||
[For better viewing, including hyperlinks, read it online at ]:#
|
||||
[https://github.com/kvz/bash3boilerplate/blob/master/README.md]:#
|
||||
|
||||
* [Overview](#overview)
|
||||
* [Goals](#goals)
|
||||
* [Features](#features)
|
||||
* [Installation](#installation)
|
||||
* [Changelog](#changelog)
|
||||
* [Best Practices](#best-practices)
|
||||
* [Frequently Asked Questions](#frequently-asked-questions)
|
||||
* [Authors](#authors)
|
||||
* [Sponsoring](#sponsoring)
|
||||
* [License](#license)
|
||||
|
||||
## Overview
|
||||
|
||||
When hacking up BASH scripts, I often find there are some
|
||||
higher level things like logging, configuration, command-line argument
|
||||
@ -16,7 +32,7 @@ me) programs.
|
||||
|
||||
## Goals
|
||||
|
||||
Delete-key-friendly. I propose using `main.sh` as a base and removing the
|
||||
Delete-key-friendly. I propose using [`main.sh`] as a base and removing the
|
||||
parts you don't need, rather than introducing a ton of packages, includes, compilers, etc.
|
||||
|
||||
Aiming for portability, I'm targeting Bash 3 (OSX still ships
|
||||
@ -126,11 +142,15 @@ $ my_script some more args --blah
|
||||
- In functions, use `local` before every variable declaration
|
||||
- This project settles on two spaces for tabs
|
||||
|
||||
## Frequently Asked Questions
|
||||
|
||||
Please see the [FAQ.md](./FAQ.md) file.
|
||||
|
||||
## Authors
|
||||
|
||||
- Kevin van Zonneveld (<http://kvz.io>)
|
||||
- Izaak Beekman (<https://izaakbeekman.com/>)
|
||||
- Alexander Rathai (<Alexander.Rathai@gmail.com>)
|
||||
- [Kevin van Zonneveld](<http://kvz.io>)
|
||||
- [Izaak Beekman](<https://izaakbeekman.com/>)
|
||||
- [Alexander Rathai](mailto:<Alexander.Rathai@gmail.com>)
|
||||
|
||||
## Sponsoring
|
||||
|
||||
@ -142,3 +162,5 @@ $ my_script some more args --blah
|
||||
|
||||
Copyright (c) 2013 Kevin van Zonneveld, [http://kvz.io](http://kvz.io)
|
||||
Licensed under MIT: [http://kvz.io/licenses/LICENSE-MIT](http://kvz.io/licenses/LICENSE-MIT)
|
||||
|
||||
[main.sh]: ./main.sh
|
||||
|
||||
Loading…
Reference in New Issue
Block a user