Skip to content

Commit 55ee77b

Browse files
updating Documentation V2.0
1 parent 73ab551 commit 55ee77b

File tree

5 files changed

+19
-18
lines changed

5 files changed

+19
-18
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ sudo apt update
3636
sudo apt install bashmultitool
3737
```
3838

39+
**Arch based System**
40+
41+
Package available in the Arch Linux user repo AUR
42+
3943
**For other linux systems**
4044

4145
Download latest fixed release and run the makefile as per
@@ -48,9 +52,6 @@ curl -sL https://github.com/gavinlyonsrepo/bashmultitool/archive/2.0.tar.gz | ta
4852
cd bashmultitool-2.0
4953
sudo make install
5054
```
51-
**Arch based System**
52-
53-
It's also available in the Arch Linux user repo AUR
5455

5556
Usage
5657
-------------------------------------------

documentation/bmtData.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -48,28 +48,28 @@ Returns 0 for alphabet , 2 for non alphabet.
4848
604) convert a string to lowercase
4949

5050
```sh
51-
result=$(bmtDataFunc lowercase "TEST")
52-
echo $result
51+
result=$(bmtDataFunc lowercase "TEST")
52+
echo $result
5353
```
5454

5555
605) convert a string to uppercase
5656

5757
```sh
58-
result=$(bmtDataFunc upperrcase "test")
59-
echo $result
58+
result=$(bmtDataFunc upperrcase "test")
59+
echo $result
6060
```
6161

6262
606) trim whitespace from a strin
6363

6464
```sh
65-
result2=$(bmtDataFunc trim " test "
66-
echo $result2
65+
result2=$(bmtDataFunc trim " test "
66+
echo $result2
6767
```
6868
6969
607) String Length
7070
Returns string length , maximum 249 , 250 is Null string error.
7171
7272
```sh
73-
bmtDataFunc strlen "test string 123" #15
74-
echo $?
73+
bmtDataFunc strlen "test string 123" #15
74+
echo $?
7575
```

documentation/bmtLinux.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,6 @@ bmtLinuxFunc runasroot
9292
Returns 2 if command does not exist on system.
9393

9494
```sh
95-
bmtLinuxFunc iscommand tput
96-
echo "$?"
95+
bmtLinuxFunc iscommand tput
96+
echo "$?"
9797
```

documentation/bmtNetwork.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
Keyword checknet, first option url of website. Returns 0 for connectivity , 2 for no connectivity
1515

1616
```sh
17-
bmtMiscFunc checknet "www.google.ie"
17+
bmtNetworkFunc checknet "www.google.ie"
1818
```
1919

2020
302) weather
@@ -25,5 +25,5 @@ Weather report by wttr.in, uses wget utility
2525
2. Param2 format 1-4
2626

2727
```sh
28-
bmtMiscFunc weather Dublin 4
28+
bmtNetworkFunc weather Dublin 4
2929
```

documentation/bmtTime.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ bmtTimeFunc epochnow
2929

3030
```sh
3131
# call spinner section put run in background and save PID
32-
bmtMiscFunc spin &
32+
bmtTimeFunc spin &
3333
pid=$!
3434
disown
3535

@@ -51,9 +51,9 @@ startwatch creates a global variable called _BMT_START_WATCH
5151
and uses bc An arbitrary precision calculator language.
5252

5353
```sh
54-
bmtMiscFunc startWatch
54+
bmtTimeFunc startWatch
5555
sleep 2.8
56-
bmtMiscFunc stopWatch
56+
bmtTimeFunc stopWatch
5757
# returns ~ 2.813207
5858
```
5959
708) Progress Bar

0 commit comments

Comments
 (0)