1
-
2
1
Overview
3
2
--------------------------------------------
4
- * Name: bashmultitool
5
- * Title : Bash Shell library for commonly used functions.
3
+ * Name: bashMultiTool
6
4
* Description: A Bash Shell library file for commonly used functions
7
5
can be imported into shell scripts to create functional and colorful
8
6
scripts and Terminal users interfaces(TUI).
9
7
* Author: Gavin Lyons
10
- * Communication: Upstream repo at github site below or
[email protected]
11
- * URL: [ bashmultitool] ( https://github.com/gavinlyonsrepo/bashmultitool )
12
- * History: See changelog.md in documentation section for version control history.
13
- * Copyright: Copyright (C) 2018 Gavin Lyons. See LICENSE.md in documentation section.
14
8
15
9
Table of contents
16
10
---------------------------
17
11
18
12
* [ Installation] ( #installation )
13
+ * [ Dependencies] ( #dependencies )
19
14
* [ Usage] ( #usage )
20
15
* [ Files] ( #files )
21
- * [ Features] ( #features )
22
- * [ Communication] ( #communication )
23
- * [ Dependencies] ( #dependencies )
24
-
16
+ * [ Software] ( #software )
25
17
26
18
Installation
27
19
-----------------------------------------------
@@ -56,6 +48,12 @@ sudo make install
56
48
57
49
It's also available in the Arch Linux user repo AUR
58
50
51
+ Dependencies
52
+ -------------------------------------
53
+ 1 . GNU bash, version 4.4.18-2
54
+
55
+ 2 . The check website section requires netcat installed. [ Netcat] ( https://en.wikipedia.org/wiki/Netcat )
56
+
59
57
Usage
60
58
-------------------------------------------
61
59
Source the library from your bash shell scripts like so:
@@ -111,7 +109,7 @@ Files and setup
111
109
| bmtData | btmDataFunc | 601-606 | Data related | [ bmtData help file] ( documentation/bmtData.md ) |
112
110
113
111
114
- Features
112
+ Software
115
113
----------------------
116
114
The library contains six files and six functions,
117
115
which contains 27 sections in total.
@@ -126,14 +124,12 @@ data related and miscellaneous.
126
124
127
125
Colours: Black, Red, Green, Yellow, Blue, Purple, Cyan, White.
128
126
129
- Modes: normal, bold, underline, background, hiy, bold hiy, background hiy.
130
-
131
- Note: hiy = high intensity.
132
-
127
+ Modes: normal, bold, underline, background, high intensity,
128
+ bold high intensity, background high intensity.
129
+
133
130
Example Output:
134
131
135
- ![ ScreenShot] ( https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/screenshot/colour_print_example.png )
136
-
132
+ ![ ScreenShot] ( https://raw.githubusercontent.com/gavinlyonsrepo/bashmultitool/master/documentation/screenshot/colour_print_example.png )
137
133
138
134
* 201 Horizontal lines across terminal in any colour
139
135
* 202 yes-no-quit [ y/n/q] prompt
@@ -165,12 +161,3 @@ Example Output:
165
161
* 604 convert string to lowercase
166
162
* 605 convert string to uppercase
167
163
* 606 trim whitespace from string
168
-
169
-
170
- Dependencies
171
- -------------------------------------
172
- 1 . GNU bash, version 4.4.18-2
173
-
174
- 2 . The check website section requires netcat installed. [ Netcat] ( https://en.wikipedia.org/wiki/Netcat )
175
-
176
-
0 commit comments