Update the manuals

2025-04-09 18:19:32 +02:00 · 2021-09-11 11:37:22 +02:00 · 2021-09-11 11:37:22 +02:00 · f0bc1b4160
commit f0bc1b4160
parent 9185eed551
30 changed files with 372 additions and 46 deletions
--- a/Docs/check-file-system.ps1.md
+++ b/Docs/check-file-system.ps1.md
@ -2,8 +2,24 @@

 ## Synopsis & Description
 ```powershell
-check-file-system.ps1 [[-Drive] <string>]
+check-file-system.ps1 [<drive>]
+```

+Checks the file system of a drive (needs admin rights)
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/check-file-system.ps1 [[-Drive] <String>] [<CommonParameters>]
+```
+
+```
+-Drive <String>
+    
+    Required?                    false
+    Position?                    1
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
 ```

 ```
@ -12,4 +28,16 @@ check-file-system.ps1 [[-Drive] <string>]
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\check-file-system.ps1 C
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of check-file-system.ps1*
--- a/Docs/check-windows-system-files.ps1.md
+++ b/Docs/check-windows-system-files.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-check-windows-system-files.ps1 
+check-windows-system-files.ps1
+```

+Checks the validity of the Windows system files (requires admin rights).
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/check-windows-system-files.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ check-windows-system-files.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\check-windows-system-files.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of check-windows-system-files.ps1*
--- a/Docs/hibernate.ps1.md
+++ b/Docs/hibernate.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-hibernate.ps1 
+hibernate.ps1
+```

+Enables hibernate mode for the local computer (needs admin rights).
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/hibernate.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ hibernate.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\hibernate.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of hibernate.ps1*
--- a/Docs/install-ssh-client.ps1.md
+++ b/Docs/install-ssh-client.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-install-ssh-client.ps1 
+install-ssh-client.ps1
+```

+Installs the SSH client (needs admin rights).
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/install-ssh-client.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ install-ssh-client.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\install-ssh-client.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of install-ssh-client.ps1*
--- a/Docs/install-ssh-server.ps1.md
+++ b/Docs/install-ssh-server.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-install-ssh-server.ps1 
+install-ssh-server.ps1
+```

+Installs the SSH server (needs admin rights).
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/install-ssh-server.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ install-ssh-server.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\install-ssh-server.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of install-ssh-server.ps1*
--- a/Docs/install-wsl.ps1.md
+++ b/Docs/install-wsl.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-install-wsl.ps1 
+install-wsl.ps1
+```

+Installs Windows Subsystem for Linux (WSL) - needs admin rights.
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/install-wsl.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ install-wsl.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\install-wsl.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of install-wsl.ps1*
--- a/Docs/list-fritzbox-calls.ps1.md
+++ b/Docs/list-fritzbox-calls.ps1.md
@ -2,8 +2,34 @@

 ## Synopsis & Description
 ```powershell
-list-fritzbox-calls.ps1 [[-Username] <string>] [[-Password] <string>]
+list-fritzbox-calls.ps1 [<username>] [<password>]
+```

+Lists the phone calls of the FRITZ!Box device.
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/list-fritzbox-calls.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParameters>]
+```
+
+```
+-Username <String>
+    
+    Required?                    false
+    Position?                    1
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
+```
+
+```
+-Password <String>
+    
+    Required?                    false
+    Position?                    2
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
 ```

 ```
@ -12,4 +38,16 @@ list-fritzbox-calls.ps1 [[-Username] <string>] [[-Password] <string>]
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\list-fritzbox-calls.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of list-fritzbox-calls.ps1*
--- a/Docs/list-fritzbox-devices.ps1.md
+++ b/Docs/list-fritzbox-devices.ps1.md
@ -2,8 +2,34 @@

 ## Synopsis & Description
 ```powershell
-list-fritzbox-devices.ps1 [[-Username] <string>] [[-Password] <string>]
+list-fritzbox-devices.ps1 [<username>] [<password>]
+```

+Lists FRITZ!Box's known devices.
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/list-fritzbox-devices.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParameters>]
+```
+
+```
+-Username <String>
+    
+    Required?                    false
+    Position?                    1
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
+```
+
+```
+-Password <String>
+    
+    Required?                    false
+    Position?                    2
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
 ```

 ```
@ -12,4 +38,16 @@ list-fritzbox-devices.ps1 [[-Username] <string>] [[-Password] <string>]
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\list-fritzbox-devices.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of list-fritzbox-devices.ps1*
--- a/Docs/list-print-jobs.ps1.md
+++ b/Docs/list-print-jobs.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-list-print-jobs.ps1 
+list-print-jobs.ps1
+```

+Lists all jobs from all printers
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/list-print-jobs.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ list-print-jobs.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\list-print-jobs.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of list-print-jobs.ps1*
--- a/Docs/list-voices.ps1.md
+++ b/Docs/list-voices.ps1.md
@ -30,7 +30,4 @@ Author: Markus Fleschutz · License: CC0
 ## Related Links
 https://github.com/fleschutz/PowerShell

-
-Requires -Version 2.0
-
 *Generated by convert-ps2md.ps1 using the comment-based help of list-voices.ps1*
--- a/Docs/poweroff.ps1.md
+++ b/Docs/poweroff.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-poweroff.ps1 
+poweroff.ps1
+```

+Halts the local computer (needs admin rights).
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/poweroff.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ poweroff.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\poweroff.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of poweroff.ps1*
--- a/Docs/query-smart-data.ps1.md
+++ b/Docs/query-smart-data.ps1.md
@ -2,8 +2,27 @@

 ## Synopsis & Description
 ```powershell
-query-smart-data.ps1 [[-Directory] <string>]
+query-smart-data.ps1 [<directory>]
+```

+Queries the S.M.A.R.T. data of your HDD/SSD's and saves it to the current/given directory
+(use smart-data2csv.ps1 to generate a CSV table for analysis).
+
+       Requires smartctl (smartmontools) and admin rights. For automation copy this script to /etc/cron.daily
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/query-smart-data.ps1 [[-Directory] <String>] [<CommonParameters>]
+```
+
+```
+-Directory <String>
+    
+    Required?                    false
+    Position?                    1
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
 ```

 ```
@ -12,4 +31,16 @@ query-smart-data.ps1 [[-Directory] <string>]
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\query-smart-data.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of query-smart-data.ps1*
--- a/Docs/reboot.ps1.md
+++ b/Docs/reboot.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-reboot.ps1 
+reboot.ps1
+```

+Reboots the local computer (needs admin rights).
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/reboot.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ reboot.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\reboot.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of reboot.ps1*
--- a/Docs/remove-print-jobs.ps1.md
+++ b/Docs/remove-print-jobs.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-remove-print-jobs.ps1 
+remove-print-jobs.ps1
+```

+removes all jobs from all printers
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/remove-print-jobs.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ remove-print-jobs.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\remove-print-jobs.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+https://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of remove-print-jobs.ps1*
--- a/Docs/restart-network-adapters.ps1.md
+++ b/Docs/restart-network-adapters.ps1.md
@ -2,8 +2,14 @@

 ## Synopsis & Description
 ```powershell
-restart-network-adapters.ps1 
+restart-network-adapters.ps1
+```

+Restarts all local network adapters (needs admin rights).
+
+## Syntax & Parameters
+```powershell
+/home/mf/PowerShell/Scripts/restart-network-adapters.ps1 [<CommonParameters>]
 ```

 ```
@ -12,4 +18,16 @@ restart-network-adapters.ps1
    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
 ```

+## Example
+```powershell
+PS>.\restart-network-adapters.ps1
+```
+
+
+## Notes
+Author: Markus Fleschutz · License: CC0
+
+## Related Links
+htts://github.com/fleschutz/PowerShell
+
 *Generated by convert-ps2md.ps1 using the comment-based help of restart-network-adapters.ps1*
--- a/Scripts/check-file-system.ps1
+++ b/Scripts/check-file-system.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	check-file-system.ps1 [<drive>] 
 .DESCRIPTION
@ -12,6 +11,8 @@
 	Author: Markus Fleschutz · License: CC0
 #>

+#Requires -RunAsAdministrator
+
 param([string]$Drive = "")

 try {
--- a/Scripts/check-windows-system-files.ps1
+++ b/Scripts/check-windows-system-files.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	check-windows-system-files.ps1 
 .DESCRIPTION
@ -12,6 +11,8 @@
 	Author: Markus Fleschutz · License: CC0
 #>

+#Requires -RunAsAdministrator
+
 try {
 	sfc /verifyOnly
 	if ($lastExitCode -ne "0") { throw "'sfc /verifyOnly' failed" }
--- a/Scripts/hibernate.ps1
+++ b/Scripts/hibernate.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	hibernate.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 try {
 	[Void][System.Reflection.Assembly]::LoadWithPartialName("System.Windows.Forms") 
 	[System.Windows.Forms.Application]::SetSuspendState("Hibernate", $false, $false);
--- a/Scripts/install-ssh-client.ps1
+++ b/Scripts/install-ssh-client.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	install-ssh-client.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 try {
 	$StopWatch = [system.diagnostics.stopwatch]::startNew()

--- a/Scripts/install-ssh-server.ps1
+++ b/Scripts/install-ssh-server.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	install-ssh-server.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 try {
 	$StopWatch = [system.diagnostics.stopwatch]::startNew()

--- a/Scripts/install-wsl.ps1
+++ b/Scripts/install-wsl.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	install-wsl.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 try {
 	$StopWatch = [system.diagnostics.stopwatch]::startNew()

--- a/Scripts/list-fritzbox-calls.ps1
+++ b/Scripts/list-fritzbox-calls.ps1
@ -1,5 +1,4 @@
-#Requires -Version 3
-<#
+<#
 .SYNOPSIS
 	list-fritzbox-calls.ps1 [<username>] [<password>]
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -Version 3
+
 param([string]$Username = "", [string]$Password = "")

 if ($Username -eq "") { $Username = read-host "Enter username for FRITZ!Box" }
--- a/Scripts/list-fritzbox-devices.ps1
+++ b/Scripts/list-fritzbox-devices.ps1
@ -1,5 +1,4 @@
-#Requires -Version 3
-<#
+<#
 .SYNOPSIS
 	list-fritzbox-devices.ps1 [<username>] [<password>]
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -Version 3
+
 param([string]$Username = "", [string]$Password = "")

 if ($Username -eq "") { $Username = read-host "Enter username for FRITZ!Box" }
--- a/Scripts/list-print-jobs.ps1
+++ b/Scripts/list-print-jobs.ps1
@ -1,5 +1,4 @@
-#requires -version 4
-<#
+<#
 .SYNOPSIS
 	list-print-jobs.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -Version 4
+
 try {
 	$printers = Get-Printer
 	if ($printers.Count -eq 0) { throw "No printer found" }
--- a/Scripts/list-voices.ps1
+++ b/Scripts/list-voices.ps1
@ -10,7 +10,7 @@
 .LINK
 	https://github.com/fleschutz/PowerShell
 #>
-#
+
 #Requires -Version 2.0

 try {
--- a/Scripts/poweroff.ps1
+++ b/Scripts/poweroff.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	poweroff.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 try {
 	Stop-Computer
 	exit 0
--- a/Scripts/query-smart-data.ps1
+++ b/Scripts/query-smart-data.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	query-smart-data.ps1 [<directory>]
 .DESCRIPTION
@ -15,6 +14,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 param([string]$Directory = "")


--- a/Scripts/reboot.ps1
+++ b/Scripts/reboot.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	reboot.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 try {
 	Restart-Computer
 	exit 0
--- a/Scripts/remove-print-jobs.ps1
+++ b/Scripts/remove-print-jobs.ps1
@ -1,5 +1,4 @@
-#requires -version 4
-<#
+<#
 .SYNOPSIS
 	remove-print-jobs.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	https://github.com/fleschutz/PowerShell
 #>

+#Requires -Version 4
+
 try {
 	$printers = Get-Printer
 	if ($printers.Count -eq 0) { throw "No printer found" }
--- a/Scripts/restart-network-adapters.ps1
+++ b/Scripts/restart-network-adapters.ps1
@ -1,5 +1,4 @@
-#Requires -RunAsAdministrator
-<#
+<#
 .SYNOPSIS
 	restart-network-adapters.ps1
 .DESCRIPTION
@ -12,6 +11,8 @@
 	htts://github.com/fleschutz/PowerShell
 #>

+#Requires -RunAsAdministrator
+
 try {
 	$StopWatch = [system.diagnostics.stopwatch]::startNew()