Skip to content

Commit 3c69ed1

Browse files
sebthomsebthom
committed
Reformat doc
1 parent 597e386 commit 3c69ed1

19 files changed

+60
-20
lines changed

‎docs/ansi.md

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ The following commands are available when this module is loaded:
1717

1818
## <a name="license"></a>License
1919

20+
```
2021
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
2122
SPDX-License-Identifier: Apache-2.0
2223
@@ -31,6 +32,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
3132
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
3233
See the License for the specific language governing permissions and
3334
limitations under the License.
35+
```
3436

3537

3638
## <a name="-ansi-bold"></a>-ansi-bold

‎docs/aws.md

+24-20
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ The following commands are available when this module is loaded:
2121

2222
## <a name="license"></a>License
2323

24+
```
2425
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
2526
SPDX-License-Identifier: Apache-2.0
2627
@@ -35,6 +36,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
3536
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
3637
See the License for the specific language governing permissions and
3738
limitations under the License.
39+
```
3840

3941

4042
## <a name="-aws-account-id"></a>-aws-account-id
@@ -55,9 +57,9 @@ Options:
5557

5658
*Implementation:*
5759
```bash
58-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
60+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
5961

60-
$get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/accountId/ {print $4}'
62+
$http_get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/accountId/ {print $4}'
6163
```
6264

6365

@@ -79,9 +81,9 @@ Options:
7981

8082
*Implementation:*
8183
```bash
82-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
84+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
8385

84-
$get http://169.254.169.254/latest/meta-data/placement/availability-zone
86+
$http_get http://169.254.169.254/latest/meta-data/placement/availability-zone
8587
```
8688

8789

@@ -113,14 +115,14 @@ Options:
113115

114116
*Implementation:*
115117
```bash
116-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
118+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
117119

118120
if [[ ! $_region ]]; then
119-
local _region=$($get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/region/ {print $4}')
121+
local _region=$($http_get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/region/ {print $4}')
120122
fi
121123

122124
if [[ ! $_STACK_NAME ]]; then
123-
local instanceId=$($get http://169.254.169.254/latest/meta-data/instance-id)
125+
local instanceId=$($http_get http://169.254.169.254/latest/meta-data/instance-id)
124126
local _STACK_NAME=$(aws ec2 describe-instances --region $_region --instance-id $instanceId --query 'Reservations[*].Instances[*].Tags[?Key==`aws:cloudformation:stack-name`].Value' --output text)
125127
fi
126128

@@ -146,9 +148,9 @@ Options:
146148

147149
*Implementation:*
148150
```bash
149-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
151+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
150152

151-
$get http://169.254.169.254/latest/meta-data/instance-id
153+
$http_get http://169.254.169.254/latest/meta-data/instance-id
152154
```
153155

154156

@@ -201,9 +203,9 @@ Options:
201203

202204
*Implementation:*
203205
```bash
204-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
206+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
205207

206-
$get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/privateIp/ {print $4}'
208+
$http_get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/privateIp/ {print $4}'
207209
```
208210

209211

@@ -225,9 +227,9 @@ Options:
225227

226228
*Implementation:*
227229
```bash
228-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
230+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
229231

230-
$get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/region/ {print $4}'
232+
$http_get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/region/ {print $4}'
231233
```
232234

233235

@@ -252,10 +254,10 @@ Options:
252254

253255
*Implementation:*
254256
```bash
255-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
257+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
256258

257-
local region=$($get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/region/ {print $4}')
258-
local instanceId=$($get http://169.254.169.254/latest/meta-data/instance-id)
259+
local region=$($http_get http://169.254.169.254/latest/dynamic/instance-identity/document | awk -F\" '/region/ {print $4}')
260+
local instanceId=$($http_get http://169.254.169.254/latest/meta-data/instance-id)
259261
aws ec2 describe-instances --region $region --instance-id $instanceId --query 'Reservations[*].Instances[*].Tags[?Key==`aws:cloudformation:stack-name`].Value' --output text
260262
```
261263

@@ -278,9 +280,10 @@ Options:
278280

279281
*Implementation:*
280282
```bash
281-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
283+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
282284

283-
$get http://169.254.169.254/latest/meta-data/network/interfaces/macs/$($get http://169.254.169.254/latest/meta-data/mac)/vpc-ipv4-cidr-block
285+
local mac=$($http_get http://169.254.169.254/latest/meta-data/mac)
286+
$http_get http://169.254.169.254/latest/meta-data/network/interfaces/macs/$mac/vpc-ipv4-cidr-block
284287
```
285288

286289

@@ -302,9 +305,10 @@ Options:
302305

303306
*Implementation:*
304307
```bash
305-
hash wget &>/dev/null && local get="wget -qO-" || local get="curl -s"
308+
hash wget &>/dev/null && local http_get="wget -qO-" || local http_get="curl -s"
306309

307-
$get http://169.254.169.254/latest/meta-data/network/interfaces/macs/$($get http://169.254.169.254/latest/meta-data/mac)/vpc-id
310+
local mac=$($http_get http://169.254.169.254/latest/meta-data/mac)
311+
$http_get http://169.254.169.254/latest/meta-data/network/interfaces/macs/$mac/vpc-id
308312
```
309313

310314

‎docs/compression.md

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The following commands are available when this module is loaded:
2222

2323
## <a name="license"></a>License
2424

25+
```
2526
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
2627
SPDX-License-Identifier: Apache-2.0
2728
@@ -36,6 +37,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
3637
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
3738
See the License for the specific language governing permissions and
3839
limitations under the License.
40+
```
3941

4042

4143
## <a name="-tar-gz"></a>-tar-gz

‎docs/crypto.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The following commands are available when this module is loaded:
1212

1313
## <a name="license"></a>License
1414

15+
```
1516
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1617
SPDX-License-Identifier: Apache-2.0
1718
@@ -26,6 +27,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2627
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2728
See the License for the specific language governing permissions and
2829
limitations under the License.
30+
```
2931

3032

3133
## <a name="-md5sum"></a>-md5sum

‎docs/filesystem.md

+2
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ The following commands are available when this module is loaded:
2626

2727
## <a name="license"></a>License
2828

29+
```
2930
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
3031
SPDX-License-Identifier: Apache-2.0
3132
@@ -40,6 +41,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
4041
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
4142
See the License for the specific language governing permissions and
4243
limitations under the License.
44+
```
4345

4446

4547
## <a name="-abspath"></a>-abspath

‎docs/functions.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The following commands are available when this module is loaded:
1313

1414
## <a name="license"></a>License
1515

16+
```
1617
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1718
SPDX-License-Identifier: Apache-2.0
1819
@@ -27,6 +28,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2728
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2829
See the License for the specific language governing permissions and
2930
limitations under the License.
31+
```
3032

3133

3234
## <a name="-fn-copy"></a>-fn-copy

‎docs/git.md

+2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ The following commands are available when this module is loaded:
2727

2828
## <a name="license"></a>License
2929

30+
```
3031
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
3132
SPDX-License-Identifier: Apache-2.0
3233
@@ -41,6 +42,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
4142
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
4243
See the License for the specific language governing permissions and
4344
limitations under the License.
45+
```
4446

4547

4648
## <a name="-git-branch-name"></a>-git-branch-name

‎docs/math.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ The following commands are available when this module is loaded:
1212

1313
## <a name="license"></a>License
1414

15+
```
1516
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1617
SPDX-License-Identifier: Apache-2.0
1718
@@ -26,6 +27,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2627
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2728
See the License for the specific language governing permissions and
2829
limitations under the License.
30+
```
2931

3032

3133
## <a name="-calc"></a>-calc

‎docs/memory.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The following commands are available when this module is loaded:
1313

1414
## <a name="license"></a>License
1515

16+
```
1617
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1718
SPDX-License-Identifier: Apache-2.0
1819
@@ -27,6 +28,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2728
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2829
See the License for the specific language governing permissions and
2930
limitations under the License.
31+
```
3032

3133

3234
## <a name="-alloc-mem"></a>-alloc-mem

‎docs/misc.md

+2
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ The following commands are available when this module is loaded:
3232

3333
## <a name="license"></a>License
3434

35+
```
3536
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
3637
SPDX-License-Identifier: Apache-2.0
3738
@@ -46,6 +47,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
4647
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
4748
See the License for the specific language governing permissions and
4849
limitations under the License.
50+
```
4951

5052

5153
## <a name="-choose"></a>-choose

‎docs/network.md

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ The following commands are available when this module is loaded:
1616

1717
## <a name="license"></a>License
1818

19+
```
1920
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
2021
SPDX-License-Identifier: Apache-2.0
2122
@@ -30,6 +31,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
3031
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
3132
See the License for the specific language governing permissions and
3233
limitations under the License.
34+
```
3335

3436

3537
## <a name="-block-port"></a>-block-port

‎docs/openssl.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The following commands are available when this module is loaded:
1111

1212
## <a name="license"></a>License
1313

14+
```
1415
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1516
SPDX-License-Identifier: Apache-2.0
1617
@@ -25,6 +26,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2526
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2627
See the License for the specific language governing permissions and
2728
limitations under the License.
29+
```
2830

2931

3032
## <a name="-gen-x509cert"></a>-gen-x509cert

‎docs/os.md

+2
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ The following commands are available when this module is loaded:
1111

1212
## <a name="license"></a>License
1313

14+
```
1415
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1516
SPDX-License-Identifier: Apache-2.0
1617
@@ -25,6 +26,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2526
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2627
See the License for the specific language governing permissions and
2728
limitations under the License.
29+
```
2830

2931

3032
## <a name="-command-exists"></a>-command-exists

‎docs/performance.md

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The following commands are available when this module is loaded:
1414

1515
## <a name="license"></a>License
1616

17+
```
1718
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1819
SPDX-License-Identifier: Apache-2.0
1920
@@ -28,6 +29,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2829
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2930
See the License for the specific language governing permissions and
3031
limitations under the License.
32+
```
3133

3234

3335
## <a name="-cpu-count"></a>-cpu-count

‎docs/processes.md

+2
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ The following commands are available when this module is loaded:
1414

1515
## <a name="license"></a>License
1616

17+
```
1718
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1819
SPDX-License-Identifier: Apache-2.0
1920
@@ -28,6 +29,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2829
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2930
See the License for the specific language governing permissions and
3031
limitations under the License.
32+
```
3133

3234

3335
## <a name="-get-child-pids"></a>-get-child-pids

‎docs/random.md

+2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ The following commands are available when this module is loaded:
1313

1414
## <a name="license"></a>License
1515

16+
```
1617
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1718
SPDX-License-Identifier: Apache-2.0
1819
@@ -27,6 +28,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2728
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
2829
See the License for the specific language governing permissions and
2930
limitations under the License.
31+
```
3032

3133

3234
## <a name="-entropy-available"></a>-entropy-available

‎docs/ssh.md

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ The following commands are available when this module is loaded:
1515

1616
## <a name="license"></a>License
1717

18+
```
1819
Copyright 2015-2018 by Vegard IT GmbH, Germany, https://vegardit.com
1920
SPDX-License-Identifier: Apache-2.0
2021
@@ -29,6 +30,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
2930
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
3031
See the License for the specific language governing permissions and
3132
limitations under the License.
33+
```
3234

3335

3436
## <a name="-ssh-agent-add-key"></a>-ssh-agent-add-key

0 commit comments

Comments
 (0)