Skip to content

Commit 54635c3

Browse files
fleschutzfleschutz
committed
Updated the manuals
1 parent 53eb60b commit 54635c3

636 files changed

Lines changed: 5289 additions & 2027 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/add-firewall-rules.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script adds firewall rules for the given executable. Administrat
66
Parameters
77
----------
88
```powershell
9-
PS> ./add-firewall-rules.ps1 [[-PathToExecutables] <String>] [[-Direction] <String>] [[-FirewallProfile] <Array>] [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/add-firewall-rules.ps1 [[-PathToExecutables] <String>] [[-Direction] <String>] [[-FirewallProfile] <Array>] [<CommonParameters>]
1010
1111
-PathToExecutables <String>
1212
Specifies the path to the executables.
@@ -113,4 +113,4 @@ try {
113113
114114
```
115115

116-
*(generated by convert-ps2md.ps1 using the comment-based help of add-firewall-rules.ps1 as of 08/15/2024 09:50:44)*
116+
*(generated by convert-ps2md.ps1 using the comment-based help of add-firewall-rules.ps1 as of 11/08/2024 12:34:45)*

‎docs/alert.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script handles and escalates the given alert message.
66
Parameters
77
----------
88
```powershell
9-
PS> ./alert.ps1 [[-Message] <String>] [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/alert.ps1 [[-Message] <String>] [<CommonParameters>]
1010
1111
-Message <String>
1212
Specifies the alert message
@@ -71,4 +71,4 @@ try {
7171
}
7272
```
7373

74-
*(generated by convert-ps2md.ps1 using the comment-based help of alert.ps1 as of 08/15/2024 09:50:44)*
74+
*(generated by convert-ps2md.ps1 using the comment-based help of alert.ps1 as of 11/08/2024 12:34:45)*

‎docs/build-repo.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script builds a Git repository by supporting build systems such
66
Parameters
77
----------
88
```powershell
9-
PS> ./build-repo.ps1 [[-path] <String>] [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/build-repo.ps1 [[-path] <String>] [<CommonParameters>]
1010
1111
-path <String>
1212
Specifies the path to the Git repository (default is current working directory)
@@ -28,7 +28,7 @@ Example
2828
PS> ./build-repo.ps1 C:\Repos\ninja
2929
⏳ Building 📂ninja using CMakeLists.txt into 📂ninja/_Build_Results...
3030
...
31-
✔️ Built 📂ninja repository in 47 sec.
31+
✅ Built 📂ninja repository in 47 sec.
3232
3333
```
3434

@@ -54,7 +54,7 @@ Script Content
5454
PS> ./build-repo.ps1 C:\Repos\ninja
5555
⏳ Building 📂ninja using CMakeLists.txt into 📂ninja/_Build_Results...
5656
...
57-
✔️ Built 📂ninja repository in 47 sec.
57+
✅ Built 📂ninja repository in 47 sec.
5858
.LINK
5959
https://github.com/fleschutz/PowerShell
6060
.NOTES
@@ -188,12 +188,12 @@ try {
188188
189189
$repoDirName = (Get-Item "$path").Name
190190
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
191-
"✔️ Built 📂$repoDirName repository in $elapsed sec."
191+
"✅ Built 📂$repoDirName repository in $elapsed sec."
192192
exit 0 # success
193193
} catch {
194194
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
195195
exit 1
196196
}
197197
```
198198

199-
*(generated by convert-ps2md.ps1 using the comment-based help of build-repo.ps1 as of 08/15/2024 09:50:44)*
199+
*(generated by convert-ps2md.ps1 using the comment-based help of build-repo.ps1 as of 11/08/2024 12:34:45)*

‎docs/build-repos.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script builds all Git repositories in a folder.
66
Parameters
77
----------
88
```powershell
9-
PS> ./build-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/build-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
1010
1111
-ParentDir <String>
1212
Specifies the path to the parent folder
@@ -74,12 +74,12 @@ try {
7474
}
7575
7676
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
77-
"✔️ built $FolderCount Git repositories at 📂$ParentDirName in $Elapsed sec"
77+
"✅ Built $FolderCount Git repositories at 📂$ParentDirName in $Elapsed sec"
7878
exit 0 # success
7979
} catch {
8080
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
8181
exit 1
8282
}
8383
```
8484

85-
*(generated by convert-ps2md.ps1 using the comment-based help of build-repos.ps1 as of 08/15/2024 09:50:44)*
85+
*(generated by convert-ps2md.ps1 using the comment-based help of build-repos.ps1 as of 11/08/2024 12:34:45)*

‎docs/cd-autostart.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script changes the working directory to the user's autostart fol
66
Parameters
77
----------
88
```powershell
9-
PS> ./cd-autostart.ps1 [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/cd-autostart.ps1 [<CommonParameters>]
1010
1111
[<CommonParameters>]
1212
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
@@ -47,17 +47,17 @@ Script Content
4747
#>
4848
4949
try {
50-
$Path = Resolve-Path "$HOME/AppData/Roaming/Microsoft/Windows/Start Menu/Programs/Startup"
51-
if (-not(Test-Path "$Path" -pathType container)) {
52-
throw "Autostart folder at 📂$Path doesn't exist (yet)"
50+
$path = Resolve-Path "~/AppData/Roaming/Microsoft/Windows/Start Menu/Programs/Startup"
51+
if (-not(Test-Path "$path" -pathType container)) {
52+
throw "Autostart folder at 📂$path doesn't exist (yet)"
5353
}
54-
Set-Location "$Path"
55-
"📂$Path"
54+
Set-Location "$path"
55+
"📂$path"
5656
exit 0 # success
5757
} catch {
5858
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
5959
exit 1
6060
}
6161
```
6262

63-
*(generated by convert-ps2md.ps1 using the comment-based help of cd-autostart.ps1 as of 08/15/2024 09:50:44)*
63+
*(generated by convert-ps2md.ps1 using the comment-based help of cd-autostart.ps1 as of 11/08/2024 12:34:45)*

‎docs/cd-crashdumps.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script changes the working directory to the crash dumps director
66
Parameters
77
----------
88
```powershell
9-
PS> ./cd-crashdumps.ps1 [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/cd-crashdumps.ps1 [<CommonParameters>]
1010
1111
[<CommonParameters>]
1212
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
@@ -63,4 +63,4 @@ try {
6363
}
6464
```
6565

66-
*(generated by convert-ps2md.ps1 using the comment-based help of cd-crashdumps.ps1 as of 08/15/2024 09:50:44)*
66+
*(generated by convert-ps2md.ps1 using the comment-based help of cd-crashdumps.ps1 as of 11/08/2024 12:34:45)*

‎docs/cd-desktop.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script changes the working directory to the user's desktop folde
66
Parameters
77
----------
88
```powershell
9-
PS> ./cd-desktop.ps1 [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/cd-desktop.ps1 [<CommonParameters>]
1010
1111
[<CommonParameters>]
1212
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
@@ -48,20 +48,20 @@ Script Content
4848
4949
try {
5050
if ($IsLinux) {
51-
$Path = Resolve-Path "~/Desktop"
51+
$path = Resolve-Path "~/Desktop"
5252
} else {
53-
$Path = [Environment]::GetFolderPath('DesktopDirectory')
53+
$path = [Environment]::GetFolderPath('DesktopDirectory')
5454
}
55-
if (Test-Path "$Path" -pathType container) {
56-
Set-Location "$Path"
57-
"📂$Path"
55+
if (Test-Path "$path" -pathType container) {
56+
Set-Location "$path"
57+
"📂$path"
5858
exit 0 # success
5959
}
60-
throw "User's desktop folder at 📂$Path doesn't exist (yet)"
60+
throw "User's desktop folder at 📂$path doesn't exist (yet)"
6161
} catch {
6262
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
6363
exit 1
6464
}
6565
```
6666

67-
*(generated by convert-ps2md.ps1 using the comment-based help of cd-desktop.ps1 as of 08/15/2024 09:50:44)*
67+
*(generated by convert-ps2md.ps1 using the comment-based help of cd-desktop.ps1 as of 11/08/2024 12:34:45)*

‎docs/cd-docs.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script changes the working directory to the documents folder.
66
Parameters
77
----------
88
```powershell
9-
PS> ./cd-docs.ps1 [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/cd-docs.ps1 [<CommonParameters>]
1010
1111
[<CommonParameters>]
1212
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
@@ -48,20 +48,20 @@ Script Content
4848
4949
try {
5050
if ($IsLinux) {
51-
$Path = Resolve-Path "$HOME/Documents"
51+
$path = Resolve-Path "~/Documents"
5252
} else {
53-
$Path = [Environment]::GetFolderPath('MyDocuments')
53+
$path = [Environment]::GetFolderPath('MyDocuments')
5454
}
55-
if (-not(Test-Path "$Path" -pathType container)) {
56-
throw "Documents folder at 📂$Path doesn't exist (yet)"
55+
if (-not(Test-Path "$path" -pathType container)) {
56+
throw "Documents folder at 📂$path doesn't exist (yet)"
5757
}
58-
Set-Location "$Path"
59-
"📂$Path"
58+
Set-Location "$path"
59+
"📂$path"
6060
exit 0 # success
6161
} catch {
6262
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
6363
exit 1
6464
}
6565
```
6666

67-
*(generated by convert-ps2md.ps1 using the comment-based help of cd-docs.ps1 as of 08/15/2024 09:50:44)*
67+
*(generated by convert-ps2md.ps1 using the comment-based help of cd-docs.ps1 as of 11/08/2024 12:34:45)*

‎docs/cd-downloads.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script changes the working directory to the user's downloads fol
66
Parameters
77
----------
88
```powershell
9-
PS> ./cd-downloads.ps1 [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/cd-downloads.ps1 [<CommonParameters>]
1010
1111
[<CommonParameters>]
1212
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
@@ -48,20 +48,20 @@ Script Content
4848
4949
try {
5050
if ($IsLinux) {
51-
$Path = Resolve-Path "~/Downloads"
51+
$path = Resolve-Path "~/Downloads"
5252
} else {
53-
$Path = (New-Object -ComObject Shell.Application).NameSpace('shell:Downloads').Self.Path
53+
$path = (New-Object -ComObject Shell.Application).NameSpace('shell:Downloads').Self.Path
5454
}
55-
if (Test-Path "$Path" -pathType container) {
56-
Set-Location "$Path"
57-
"📂$Path"
55+
if (Test-Path "$path" -pathType container) {
56+
Set-Location "$path"
57+
"📂$path"
5858
exit 0 # success
5959
}
60-
throw "User's downloads folder at 📂$Path doesn't exist (yet)"
60+
throw "User's downloads folder at 📂$path doesn't exist (yet)"
6161
} catch {
6262
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
6363
exit 1
6464
}
6565
```
6666

67-
*(generated by convert-ps2md.ps1 using the comment-based help of cd-downloads.ps1 as of 08/15/2024 09:50:44)*
67+
*(generated by convert-ps2md.ps1 using the comment-based help of cd-downloads.ps1 as of 11/08/2024 12:34:45)*

‎docs/cd-dropbox.md‎

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ This PowerShell script changes the working directory to the user's Dropbox folde
66
Parameters
77
----------
88
```powershell
9-
PS> ./cd-dropbox.ps1 [<CommonParameters>]
9+
/home/markus/Repos/PowerShell/scripts/cd-dropbox.ps1 [<CommonParameters>]
1010
1111
[<CommonParameters>]
1212
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
@@ -47,17 +47,15 @@ Script Content
4747
#>
4848
4949
try {
50-
$Path = Resolve-Path "$HOME/Dropbox"
51-
if (-not(Test-Path "$Path" -pathType container)) {
52-
throw "Dropbox folder at 📂$Path doesn't exist (yet)"
53-
}
54-
Set-Location "$Path"
55-
"📂$Path"
50+
$path = Resolve-Path "~/Dropbox"
51+
if (-not(Test-Path "$path" -pathType container)) { throw "No Dropbox folder at 📂$path - is Dropbox installed?" }
52+
Set-Location "$path"
53+
"📂$path"
5654
exit 0 # success
5755
} catch {
58-
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
56+
"⚠️ Error: $($Error[0])"
5957
exit 1
6058
}
6159
```
6260

63-
*(generated by convert-ps2md.ps1 using the comment-based help of cd-dropbox.ps1 as of 08/15/2024 09:50:44)*
61+
*(generated by convert-ps2md.ps1 using the comment-based help of cd-dropbox.ps1 as of 11/08/2024 12:34:45)*

0 commit comments

Comments
 (0)