Update the manuals

OHGUN · Jul 29, 2023 · 2e7c40c · 2e7c40c
1 parent d4d37d6
commit 2e7c40c
Show file tree

Hide file tree

Showing 554 changed files with 6,927 additions and 3,740 deletions.
diff --git a/Docs/add-firewall-rules.md b/Docs/add-firewall-rules.md
@@ -1,8 +1,10 @@
-## Script: *add-firewall-rules.ps1*
+PS> *add-firewall-rules.ps1*
+====================
 
 This PowerShell script adds firewall rules for the given executable. Administrator rights are required.
 
-## Parameters
+Parameters
+----------
 ```powershell
 add-firewall-rules.ps1 [[-PathToExecutables] <String>] [<CommonParameters>]
 
@@ -20,7 +22,8 @@ add-firewall-rules.ps1 [[-PathToExecutables] <String>] [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./add-firewall-rules C:\MyApp\bin
 Adding firewall rule for C:\MyApp\bin\app1.exe
@@ -29,13 +32,16 @@ Adding firewall rule for C:\MyApp\bin\app2.exe
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -103,4 +109,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of add-firewall-rules.ps1 as of 07/29/2023 09:55:08)*
+*(generated by convert-ps2md.ps1 using the comment-based help of add-firewall-rules.ps1 as of 07/29/2023 10:04:03)*
diff --git a/Docs/add-memo.md b/Docs/add-memo.md
@@ -1,8 +1,10 @@
-## Script: *add-memo.ps1*
+PS> *add-memo.ps1*
+====================
 
 This PowerShell script saves the given memo text to Memos.csv in your home folder.
 
-## Parameters
+Parameters
+----------
 ```powershell
 add-memo.ps1 [[-text] <String>] [<CommonParameters>]
 
@@ -20,20 +22,24 @@ add-memo.ps1 [[-text] <String>] [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./add-memo "Buy apples"
 ✔️ saved to 📄/home/markus/Memos.csv
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -73,4 +79,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of add-memo.ps1 as of 07/29/2023 09:55:08)*
+*(generated by convert-ps2md.ps1 using the comment-based help of add-memo.ps1 as of 07/29/2023 10:04:03)*
diff --git a/Docs/alert.md b/Docs/alert.md
@@ -1,8 +1,10 @@
-## Script: *alert.ps1*
+PS> *alert.ps1*
+====================
 
 This PowerShell script handles and escalates the given alert message.
 
-## Parameters
+Parameters
+----------
 ```powershell
 alert.ps1 [[-Message] <String>] [<CommonParameters>]
 
@@ -20,19 +22,23 @@ alert.ps1 [[-Message] <String>] [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./alert "Harddisk failure"
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -65,4 +71,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of alert.ps1 as of 07/29/2023 09:55:08)*
+*(generated by convert-ps2md.ps1 using the comment-based help of alert.ps1 as of 07/29/2023 10:04:03)*
diff --git a/Docs/build-repo.md b/Docs/build-repo.md
@@ -1,8 +1,10 @@
-## Script: *build-repo.ps1*
+PS> *build-repo.ps1*
+====================
 
 This PowerShell script builds a repository by supporting: cmake, configure, autogen, Imakefile, and Makefile.
 
-## Parameters
+Parameters
+----------
 ```powershell
 build-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
 
@@ -20,19 +22,23 @@ build-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./build-repo C:\MyRepo
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -171,4 +177,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of build-repo.ps1 as of 07/29/2023 09:55:08)*
+*(generated by convert-ps2md.ps1 using the comment-based help of build-repo.ps1 as of 07/29/2023 10:04:03)*
diff --git a/Docs/build-repos.md b/Docs/build-repos.md
@@ -1,8 +1,10 @@
-## Script: *build-repos.ps1*
+PS> *build-repos.ps1*
+====================
 
 This PowerShell script builds all Git repositories in a folder.
 
-## Parameters
+Parameters
+----------
 ```powershell
 build-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
 
@@ -20,19 +22,23 @@ build-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./build-repos C:\MyRepos
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -76,4 +82,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of build-repos.ps1 as of 07/29/2023 09:55:08)*
+*(generated by convert-ps2md.ps1 using the comment-based help of build-repos.ps1 as of 07/29/2023 10:04:03)*
diff --git a/Docs/cd-autostart.md b/Docs/cd-autostart.md
@@ -1,8 +1,10 @@
-## Script: *cd-autostart.ps1*
+PS> *cd-autostart.ps1*
+====================
 
 This PowerShell script changes the working directory to the user's autostart folder.
 
-## Parameters
+Parameters
+----------
 ```powershell
 cd-autostart.ps1 [<CommonParameters>]
 
@@ -11,20 +13,24 @@ cd-autostart.ps1 [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./cd-autostart
 📂C:\Users\Markus\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -54,4 +60,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of cd-autostart.ps1 as of 07/29/2023 09:55:09)*
+*(generated by convert-ps2md.ps1 using the comment-based help of cd-autostart.ps1 as of 07/29/2023 10:04:03)*
diff --git a/Docs/cd-crashdumps.md b/Docs/cd-crashdumps.md
@@ -1,8 +1,10 @@
-## Script: *cd-crashdumps.ps1*
+PS> *cd-crashdumps.ps1*
+====================
 
 This PowerShell script changes the working directory to the crash dumps directory (Windows only).
 
-## Parameters
+Parameters
+----------
 ```powershell
 cd-crashdumps.ps1 [<CommonParameters>]
 
@@ -11,20 +13,24 @@ cd-crashdumps.ps1 [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./cd-crashdumps
 📂C:\Users\Markus\AppData\Local\CrashDumps
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -54,4 +60,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of cd-crashdumps.ps1 as of 07/29/2023 09:55:09)*
+*(generated by convert-ps2md.ps1 using the comment-based help of cd-crashdumps.ps1 as of 07/29/2023 10:04:03)*
diff --git a/Docs/cd-desktop.md b/Docs/cd-desktop.md
@@ -1,8 +1,10 @@
-## Script: *cd-desktop.ps1*
+PS> *cd-desktop.ps1*
+====================
 
 This PowerShell script changes the working directory to the user's desktop folder.
 
-## Parameters
+Parameters
+----------
 ```powershell
 cd-desktop.ps1 [<CommonParameters>]
 
@@ -11,20 +13,24 @@ cd-desktop.ps1 [<CommonParameters>]
     WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```
 
-## Example
+Example
+-------
 ```powershell
 PS> ./cd-desktop
 📂/home/Markus/Desktop
 
 ```
 
-## Notes
+Notes
+-----
 Author: Markus Fleschutz | License: CC0
 
-## Related Links
+Related Links
+-------------
 https://github.com/fleschutz/PowerShell
 
-## Script Content
+Script Content
+--------------
 ```powershell
 <#
 .SYNOPSIS
@@ -58,4 +64,4 @@ try {
 }
 ```
 
-*(generated by convert-ps2md.ps1 using the comment-based help of cd-desktop.ps1 as of 07/29/2023 09:55:09)*
+*(generated by convert-ps2md.ps1 using the comment-based help of cd-desktop.ps1 as of 07/29/2023 10:04:03)*