Updated the manuals

Author: fleschutz

docs/add-firewall-rules.md

@@ -15,6 +15,7 @@ Parameters
     Position?                    1
     Default value                
     Accept pipeline input?       false
+    Aliases                      
     Accept wildcard characters?  false
 
 -Direction <String>
@@ -24,6 +25,7 @@ Parameters
     Position?                    2
     Default value                Inbound
     Accept pipeline input?       false
+    Aliases                      
     Accept wildcard characters?  false
 
 -FirewallProfile <Array>
@@ -32,6 +34,7 @@ Parameters
     Position?                    3
     Default value                @("Domain", "Private")
     Accept pipeline input?       false
+    Aliases                      
     Accept wildcard characters?  false
 
 [<CommonParameters>]
@@ -113,4 +116,4 @@ try {
 
 ```
 
-*(page generated by convert-ps2md.ps1 as of 01/23/2025 12:15:19)*
+*(page generated by convert-ps2md.ps1 as of 05/12/2025 22:02:52)*

docs/alert.md

@@ -15,6 +15,7 @@ Parameters
     Position?                    1
     Default value                
     Accept pipeline input?       false
+    Aliases                      
     Accept wildcard characters?  false
 
 [<CommonParameters>]
@@ -71,4 +72,4 @@ try {
 }
 ```
 
-*(page generated by convert-ps2md.ps1 as of 01/23/2025 12:15:19)*
+*(page generated by convert-ps2md.ps1 as of 05/12/2025 22:02:52)*

docs/build-repo.md

@@ -1,20 +1,21 @@
 The *build-repo.ps1* Script
 ===========================
 
-This PowerShell script builds a Git repository by supporting build systems such as: autogen, cmake, configure, Gradle, Imakefile, Makefile, and Meson.
+This PowerShell script builds a Git repository by supporting the build systems: autogen, cmake, configure, Gradle, Imakefile, Makefile, and Meson.
 
 Parameters
 ----------
 ```powershell
 /Repos/PowerShell/scripts/build-repo.ps1 [[-path] <String>] [<CommonParameters>]
 
 -path <String>
-    Specifies the path to the Git repository (default is current working directory)
+    Specifies the path to the Git repository (current working directory by default)
     
     Required?                    false
     Position?                    1
     Default value                "$PWD"
     Accept pipeline input?       false
+    Aliases                      
     Accept wildcard characters?  false
 
 [<CommonParameters>]
@@ -26,9 +27,9 @@ Example
 -------
 ```powershell
 PS> ./build-repo.ps1 C:\Repos\ninja
-⏳ Building 📂ninja using CMakeLists.txt into 📂ninja/_Build_Results...
+⏳ Building 📂ninja by using CMake...
 ...
-✅ Built 📂ninja repository in 47 sec.
+✅ Build of 📂ninja succeeded in 47s, results in: 📂C:\Repos\ninja\_results
 
 ```
 
@@ -45,16 +46,16 @@ Script Content
 ```powershell
 <#
 .SYNOPSIS
-	Builds a repository 
+	Builds a repo
 .DESCRIPTION
-	This PowerShell script builds a Git repository by supporting build systems such as: autogen, cmake, configure, Gradle, Imakefile, Makefile, and Meson.
+	This PowerShell script builds a Git repository by supporting the build systems: autogen, cmake, configure, Gradle, Imakefile, Makefile, and Meson.
 .PARAMETER path
-	Specifies the path to the Git repository (default is current working directory)
+	Specifies the path to the Git repository (current working directory by default)
 .EXAMPLE
 	PS> ./build-repo.ps1 C:\Repos\ninja
-	⏳ Building 📂ninja using CMakeLists.txt into 📂ninja/_Build_Results...
+	⏳ Building 📂ninja by using CMake...
 	...
-	✅ Built 📂ninja repository in 47 sec.
+	✅ Build of 📂ninja succeeded in 47s, results in: 📂C:\Repos\ninja\_results
 .LINK
 	https://github.com/fleschutz/PowerShell
 .NOTES
@@ -63,114 +64,114 @@ Script Content
 
 param([string]$path = "$PWD")
 
-function BuildInDir([string]$path) {
+function BuildFolder([string]$path) {
 	$dirName = (Get-Item "$path").Name
 	if (Test-Path "$path/CMakeLists.txt" -pathType leaf) {
-		"⏳ (1/4) Building 📂$dirName by using CMake into 📂$dirName/_Build_Results..."
-		if (-not(Test-Path "$path/_Build_Results/" -pathType container)) { 
-			& mkdir "$path/_Build_Results/"
+		"⏳ (1/4) Building 📂$dirName by using CMake..."
+		$global:results = "$path/_results/"
+		if (-not(Test-Path $global:results -pathType container)) { 
+			& mkdir $global:results
 		}
-		Set-Location "$path/_Build_Results/"
+		Set-Location $global:results
 
 		"⏳ (2/4) Executing 'cmake' to generate the Makefile..."
 		& cmake ..
-		if ($lastExitCode -ne "0") { throw "Executing 'cmake ..' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing 'cmake ..' failed with exit code $lastExitCode" }
 
 		"⏳ (3/4) Executing 'make -j4' to compile and link..."
 		& make -j4
-		if ($lastExitCode -ne "0") { throw "Executing 'make -j4' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing 'make -j4' failed with exit code $lastExitCode" }
 
-		"⏳ (4/4) Executing 'ctest -V' to perform tests (optional)..."
+		"⏳ (4/4) Executing 'ctest -V'... (if tests are provided)"
 		& ctest -V
-		if ($lastExitCode -ne "0") { throw "Executing 'ctest -V' exited with error code $lastExitCode" }
-
+		if ($lastExitCode -ne 0) { throw "Executing 'ctest -V' failed with exit code $lastExitCode" }
 	} elseif (Test-Path "$path/autogen.sh" -pathType leaf) { 
-		"⏳ Building 📂$dirName by using 'autogen.sh'..."
+		"⏳ Building 📂$dirName by executing 'autogen.sh'..."
 		Set-Location "$path/"
-
 		& ./autogen.sh --force
-		if ($lastExitCode -ne "0") { throw "Executing './autogen.sh --force' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing './autogen.sh --force' failed with exit code $lastExitCode" }
+		"⏳ Executing './configure'..."
 
 		& ./configure
-		if ($lastExitCode -ne "0") { throw "Executing './configure' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing './configure' failed with exit code $lastExitCode" }
 
 		& make -j4
-		if ($lastExitCode -ne "0") { throw "Executing 'make -j4' exited with error code $lastExitCode" }
-
+		if ($lastExitCode -ne 0) { throw "Executing 'make -j4' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/configure" -pathType leaf) { 
-		"⏳ Building 📂$dirName by using 'configure'..."
+		"⏳ Building 📂$dirName by executing './configure' and 'make'..."
 		Set-Location "$path/"
 
 		& ./configure
-		#if ($lastExitCode -ne "0") { throw "Executing './configure' exited with error code $lastExitCode" }
+		#if ($lastExitCode -ne 0) { throw "Executing './configure' exited with error code $lastExitCode" }
 
 		& make -j4
-		if ($lastExitCode -ne "0") { throw "Executing 'make -j4' has failed" }
+		if ($lastExitCode -ne 0) { throw "Executing 'make -j4' failed with exit code $lastExitCode" }
 
 		& make test
-		if ($lastExitCode -ne "0") { throw "Executing 'make test' has failed" }
+		if ($lastExitCode -ne 0) { throw "Executing 'make test' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/build.gradle" -pathType leaf) {
 		"⏳ Building 📂$dirName by using Gradle..."
 		Set-Location "$path"
 
 		& gradle build
-		if ($lastExitCode -ne "0") { throw "Executing 'gradle build' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing 'gradle build' failed with exit code $lastExitCode" }
 
 		& gradle test
-		if ($lastExitCode -ne "0") { throw "Executing 'gradle test' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing 'gradle test' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/meson.build" -pathType leaf) {
 		"⏳ Building 📂$dirName by using Meson..."
 		Set-Location "$path"
 		& meson . build --prefix=/usr/local
-		if ($lastExitCode -ne "0") { throw "Executing 'meson . build' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing 'meson . build' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/Imakefile" -pathType leaf) {
 		"⏳ Building 📂$dirName by using Imakefile..."
 		Set-Location "$path/"
 
 		& xmkmf 
-		if ($lastExitCode -ne "0") { throw "Executing 'xmkmf' has failed" }
+		if ($lastExitCode -ne 0) { throw "Executing 'xmkmf' failed with exit code $lastExitCode" }
 
 		& make -j4
-		if ($lastExitCode -ne "0") { throw "Executing 'make -j4' has failed" }
+		if ($lastExitCode -ne 0) { throw "Executing 'make -j4' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/Makefile" -pathType leaf) {
 		"⏳ Building 📂$dirName by using Makefile..."
 		Set-Location "$path"
 
 		& make -j4
-		if ($lastExitCode -ne "0") { throw "Executing 'make -j4' has failed" }
+		if ($lastExitCode -ne 0) { throw "Executing 'make -j4' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/makefile" -pathType leaf) {
 		"⏳ Building 📂$dirName by using makefile..."
 		Set-Location "$path"
 
 		& make -j4
-		if ($lastExitCode -ne "0") { throw "Executing 'make -j4' has failed" }
+		if ($lastExitCode -ne 0) { throw "Executing 'make -j4' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/compile.sh" -pathType leaf) { 
-		"⏳ Building 📂$dirName by using 'compile.sh'..."
+		"⏳ Building 📂$dirName by executing 'compile.sh'..."
 		Set-Location "$path/"
 
 		& ./compile.sh
-		if ($lastExitCode -ne "0") { throw "Executing './compile.sh' exited with error code $lastExitCode" }
+		if ($lastExitCode -ne 0) { throw "Executing './compile.sh' failed with exit code $lastExitCode" }
 
 		& make -j4
-		if ($lastExitCode -ne "0") { throw "Executing 'make -j4' has failed" }
+		if ($lastExitCode -ne 0) { throw "Executing 'make -j4' failed with exit code $lastExitCode" }
 
 	} elseif (Test-Path "$path/attower/src/build/DevBuild/build.bat" -pathType leaf) {
-		"⏳ Building 📂$dirName by using build.bat ..."
-		Set-Location "$path/attower/src/build/DevBuild/"
 
-		& ./build.bat build-all-release
-		if ($lastExitCode -ne "0") { throw "Executing 'build.bat build-all-release' exited with error code $lastExitCode" }
+		Write-Host "⏳ Building 📂$dirName by executing 'build.bat'..."
+		Set-Location "$path/attower/src/build/DevBuild/"
+		& ./build.bat build-core-release
+		if ($lastExitCode -ne 0) { throw "Executing 'build.bat' failed with exit code $lastExitCode" }
+		$global:results = "$path\attower\Executables"
 
 	} elseif (Test-Path "$path/$dirName" -pathType container) {
 		"⏳ No make rule found, trying subfolder 📂$($dirName)..."
-		BuildInDir "$path/$dirName"
+		BuildFolder "$path/$dirName"
 	} else {
 		Write-Warning "Sorry, no make rule applies to: 📂$dirName"
 		exit 0 # success
@@ -179,21 +180,27 @@ function BuildInDir([string]$path) {
 
 try {
 	$stopWatch = [system.diagnostics.stopwatch]::startNew()
+	$previousPath = Get-Location
 
-	if (-not(Test-Path "$path" -pathType container)) { throw "Can't access directory: $path" }
+	if (-not(Test-Path "$path" -pathType container)) { throw "The file path '$path' doesn't exist (yet)" }
 
-	$previousPath = Get-Location
-	BuildInDir "$path"
+	$global:results = ""
+	BuildFolder "$path"
 	Set-Location "$previousPath"
 
 	$repoDirName = (Get-Item "$path").Name
 	[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
-	"✅ Built 📂$repoDirName repository in $elapsed sec."
+	if ($global:results -eq "") {
+		"✅ Build of 📂$repoDirName succeeded in $($elapsed)s."
+	} else {
+		"✅ Build of 📂$repoDirName succeeded in $($elapsed)s, results in: 📂$($global:results)"
+	}
 	exit 0 # success
 } catch {
 	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	Set-Location "$previousPath"
 	exit 1
 }
 ```
 
-*(page generated by convert-ps2md.ps1 as of 01/23/2025 12:15:19)*
+*(page generated by convert-ps2md.ps1 as of 05/12/2025 22:02:52)*

docs/build-repos.md

@@ -15,6 +15,7 @@ Parameters
     Position?                    1
     Default value                "$PWD"
     Accept pipeline input?       false
+    Aliases                      
     Accept wildcard characters?  false
 
 [<CommonParameters>]
@@ -82,4 +83,4 @@ try {
 }
 ```
 
-*(page generated by convert-ps2md.ps1 as of 01/23/2025 12:15:19)*
+*(page generated by convert-ps2md.ps1 as of 05/12/2025 22:02:52)*

docs/cd-autostart.md

@@ -49,15 +49,15 @@ Script Content
 try {
 	$path = Resolve-Path "~/AppData/Roaming/Microsoft/Windows/Start Menu/Programs/Startup"
 	if (-not(Test-Path "$path" -pathType container)) {
-		throw "Autostart folder at 📂$path doesn't exist (yet)"
+		throw "No autostart folder at 📂$path"
 	}
 	Set-Location "$path"
 	"📂$path"
 	exit 0 # success
 } catch {
-	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	"⚠️ Error: $($Error[0])"
 	exit 1
 }
 ```
 
-*(page generated by convert-ps2md.ps1 as of 01/23/2025 12:15:19)*
+*(page generated by convert-ps2md.ps1 as of 05/12/2025 22:02:52)*

docs/cd-crashdumps.md

@@ -17,7 +17,7 @@ Example
 -------
 ```powershell
 PS> ./cd-crashdumps
-📂C:\Users\Markus\AppData\Local\CrashDumps
+📂C:\Users\Markus\AppData\Local\CrashDumps entered (has 3 files and 0 folders)
 
 ```
 
@@ -39,7 +39,7 @@ Script Content
 	This PowerShell script changes the working directory to the crash dumps directory (Windows only). Whenever a software crashes and crash dumps are enabled(!) a crash dump file is written. This file helps to identify the reason for the crash.
 .EXAMPLE
 	PS> ./cd-crashdumps
-	📂C:\Users\Markus\AppData\Local\CrashDumps
+	📂C:\Users\Markus\AppData\Local\CrashDumps entered (has 3 files and 0 folders)
 .LINK
 	https://github.com/fleschutz/PowerShell
 .NOTES
@@ -50,17 +50,19 @@ try {
 	if ($IsLinux) { throw "Sorry, Windows only" }
 
 	[string]$path = Resolve-Path -Path "~"
-	if (!(Test-Path "$path" -pathType container)) { throw "Home directory at $path doesn't exist (yet)" }
+	if (!(Test-Path "$path" -pathType container)) { throw "No home directory at $path" }
 
 	$path += "\AppData\Local\CrashDumps"
-	if (!(Test-Path "$path" -pathType container)) { throw "Crashdumps directory at $path doesn't exist (yet)" }
+	if (!(Test-Path "$path" -pathType container)) { throw "No crashdumps folder at $path" }
 	Set-Location "$Path"
-	"📂$path"
+	$files = Get-ChildItem $path -attributes !Directory
+	$folders = Get-ChildItem $path -attributes Directory
+	"📂$path entered (has $($files.Count) files and $($folders.Count) folders)"
 	exit 0 # success
 } catch {
-	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	"⚠️ Error: $($Error[0])"
 	exit 1
 }
 ```
 
-*(page generated by convert-ps2md.ps1 as of 01/23/2025 12:15:19)*
+*(page generated by convert-ps2md.ps1 as of 05/12/2025 22:02:52)*

docs/cd-desktop.md

@@ -47,21 +47,24 @@ Script Content
 #>
 
 try {
-	if ($IsLinux) {
+	if ($IsLinux -or $IsMacOS) {
+		if (-not(Test-Path "~/Desktop" -pathType container)) {
+			throw "No 📂Desktop folder in your home directory yet"
+		}
 		$path = Resolve-Path "~/Desktop"
 	} else {
 		$path = [Environment]::GetFolderPath('DesktopDirectory')
+		if (-not(Test-Path "$path" -pathType container)) {
+			throw "No desktop folder at 📂$path yet"
+		}
 	}
-	if (Test-Path "$path" -pathType container) {
-		Set-Location "$path"
-		"📂$path"
-		exit 0 # success
-	}
-	throw "User's desktop folder at 📂$path doesn't exist (yet)"
+	Set-Location "$path"
+	"📂$path"
+	exit 0 # success
 } catch {
-	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	"⚠️ Error: $($Error[0])"
 	exit 1
 }
 ```
 
-*(page generated by convert-ps2md.ps1 as of 01/23/2025 12:15:19)*
+*(page generated by convert-ps2md.ps1 as of 05/12/2025 22:02:52)*