Update the comment based help

2025-08-18 00:20:09 +02:00 · 2021-10-16 13:40:20 +02:00
parent 053b26c578
commit c296024b8f
58 changed files with 105 additions and 81 deletions
--- a/Scripts/list-aliases.ps1
+++ b/Scripts/list-aliases.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists all PowerShell aliases
 .DESCRIPTION
-	list-aliases.ps1
+	This scripts lists all PowerShell aliases.
 .EXAMPLE
 	PS> ./list-aliases

--- a/Scripts/list-anagrams.ps1
+++ b/Scripts/list-anagrams.ps1
@@ -2,7 +2,11 @@
 .SYNOPSIS
 	Lists all anagrams of the given word
 .DESCRIPTION
-	list-anagrams.ps1 [<word>] [<columns>]
+	This script lists all anagrams of the given word.
+.PARAMETER Word
+	Specifies the word to use
+.PARAMETER Columns
+	Specifies the number of columns
 .EXAMPLE
 	PS> ./list-anagrams Baby
 .NOTES
--- a/Scripts/list-automatic-variables.ps1
+++ b/Scripts/list-automatic-variables.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists all automatic variables of PowerShell
 .DESCRIPTION
-	list-automatic-variables.ps1
+	This script lists all automatic variables of PowerShell.
 .EXAMPLE
 	PS> ./list-automatic-variables

--- a/Scripts/list-branches.ps1
+++ b/Scripts/list-branches.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists all branches in a Git repository
 .DESCRIPTION
-	list-branches.ps1 [<RepoDir>] [<SearchPattern>]
+	This script lists all branches in a Git repository.
 .PARAMETER RepoDir
 	Specifies the path to the Git repository (current working directory by default)
 .PARAMETER SearchPattern
--- a/Scripts/list-cheat-sheet.ps1
+++ b/Scripts/list-cheat-sheet.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the PowerShell cheat sheet
 .DESCRIPTION
-	list-cheat-sheet.ps1 
+	This script lists the PowerShell cheat sheet.
 .EXAMPLE
 	PS> ./list-cheat-sheet
 .NOTES
--- a/Scripts/list-city-weather.ps1
+++ b/Scripts/list-city-weather.ps1
@@ -1,9 +1,8 @@
 <#
 .SYNOPSIS
-	List the current weather of cities world-wide 
+	Lists current weather of cities world-wide 
 .DESCRIPTION
-	List the current weather of cities world-wide (west to east)
-	list-city-weather.ps1
+	This script lists the current weather of cities world-wide (west to east).
 .EXAMPLE
 	PS> ./list-city-weather
 .NOTES
--- a/Scripts/list-cli-tools.ps1
+++ b/Scripts/list-cli-tools.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists available command-line interface (CLI) tools
 .DESCRIPTION
-	list-cli-tools.ps1
+	This script lists available command-line interface (CLI) tools.
 .EXAMPLE
 	PS> ./list-cli-tools

--- a/Scripts/list-clipboard.ps1
+++ b/Scripts/list-clipboard.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the contents of the clipboard
 .DESCRIPTION
-	list-clipboard.ps1
+	This script lists the contents of the clipboard.
 .EXAMPLE
 	PS> ./list-clipboard
 .NOTES
--- a/Scripts/list-cmdlets.ps1
+++ b/Scripts/list-cmdlets.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists all PowerShell cmdlets
 .DESCRIPTION
-	list-cmdlets.ps1 
+	This script lists all PowerShell cmdlets.
 .EXAMPLE
 	PS> ./list-cmdlets

--- a/Scripts/list-commits.ps1
+++ b/Scripts/list-commits.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists all commits in a Git repository
 .DESCRIPTION
-	list-commits.ps1 [<RepoDir>] [<Format>]
+	This script lists all commits in a Git repository. Supported output formats are: list, compact, normal or JSON.
 .PARAMETER RepoDir
 	Specifies the path to the Git repository.
 .PARAMETER Format
--- a/Scripts/list-console-colors.ps1
+++ b/Scripts/list-console-colors.ps1
@@ -2,9 +2,13 @@
 .SYNOPSIS
 	Lists all console colors
 .DESCRIPTION
-	list-console-colors.ps1 
+	This script lists all available console colors.
 .EXAMPLE
 	PS> ./list-console-colors
+
+	Name     Foreground     Background
+	----     ----------     ----------
+	...
 .NOTES
 	Author: Markus Fleschutz · License: CC0
 .LINK
--- a/Scripts/list-countries.ps1
+++ b/Scripts/list-countries.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists details of all countries
 .DESCRIPTION
-	list-countries.ps1 
+	This script lists details of all countries.
 .EXAMPLE
 	PS> ./list-countries
 .NOTES
--- a/Scripts/list-credits.ps1
+++ b/Scripts/list-credits.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Shows the credits for the PowerShell Scripts
 .DESCRIPTION
-	list-credits.ps1
+	This script shows the credits for the PowerShell Scripts.
 .EXAMPLE
 	PS> ./list-credits
 .NOTES
--- a/Scripts/list-crypto-rates.ps1
+++ b/Scripts/list-crypto-rates.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the current crypto exchange rates
 .DESCRIPTION
-	list-crypto-rates.ps1 
+	This script lists the current crypto exchange rates.
 .EXAMPLE
 	PS> ./list-crypto-rates
 .NOTES
--- a/Scripts/list-dir-tree.ps1
+++ b/Scripts/list-dir-tree.ps1
@@ -2,8 +2,9 @@
 .SYNOPSIS
 	Lists the full directory tree
 .DESCRIPTION
-	list-dir-tree.ps1 [<DirTree>]
-	<DirTree> is the path to the directory tree
+	This script lists the full directory tree.
+.PARAMETER DirTree
+	Specifies the path to the directory tree
 .EXAMPLE
 	PS> ./list-dir-tree C:\
 .NOTES
--- a/Scripts/list-earthquakes.ps1
+++ b/Scripts/list-earthquakes.ps1
@@ -1,8 +1,8 @@
 <#
 .SYNOPSIS
-	Lists major earthquakes for the last 30 days
+	Lists major earthquakes since 30 days
 .DESCRIPTION
-	Lists earthquakes with magnitude >= 6.0 for the last 30 days
+	This script lists earthquakes with magnitude >= 6.0 for the last 30 days.
 .EXAMPLE
 	PS> ./list-earthquakes
 .NOTES
--- a/Scripts/list-emojis.ps1
+++ b/Scripts/list-emojis.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the Emojis of Unicode 13.0
 .DESCRIPTION
-	list-emojis.ps1 
+	This script lists the emojis of Unicode 13.0 sorted by category.
 .EXAMPLE
 	PS> ./list-emojis
 .NOTES
--- a/Scripts/list-installed-software.ps1
+++ b/Scripts/list-installed-software.ps1
@@ -2,8 +2,7 @@
 .SYNOPSIS
 	Lists the installed software
 .DESCRIPTION
-	Lists the installed software (except Windows Store apps)
-	list-installed-software.ps1
+	This script lists the installed software (except Windows Store apps).
 .EXAMPLE
 	PS> ./list-installed-software
 .NOTES
--- a/Scripts/list-latest-tag.ps1
+++ b/Scripts/list-latest-tag.ps1
@@ -2,8 +2,9 @@
 .SYNOPSIS
 	Lists the latest tag on the current branch in a Git repository
 .DESCRIPTION
-	list-latest-tag.ps1 [<RepoDir>] 
-	<RepoDir> is the path to the repository
+	This script lists the latest tag on the current branch in a Git repository.
+.PARAMETER RepoDir
+	Specifies the path to the repository
 .EXAMPLE
 	PS> ./list-latest-tag C:\MyRepo
 .NOTES
--- a/Scripts/list-recycle-bin.ps1
+++ b/Scripts/list-recycle-bin.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the content of the recycle bin folder
 .DESCRIPTION
-	list-recycle-bin.ps1 
+	This script lists the content of the recycle bin folder.
 .EXAMPLE
 	PS> ./list-recycle-bin
 .NOTES
--- a/Scripts/list-system-info.ps1
+++ b/Scripts/list-system-info.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists system information of the local computer
 .DESCRIPTION
-	list-system-info.ps1
+	This script lists system information of the local computer.
 .EXAMPLE
 	PS> ./list-system-info
 .NOTES
--- a/Scripts/list-timezone.ps1
+++ b/Scripts/list-timezone.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the details of the current time zone
 .DESCRIPTION
-	list-timezone.ps1 
+	This script lists the details of the current time zone.
 .EXAMPLE
 	PS> ./list-timezone

--- a/Scripts/list-timezones.ps1
+++ b/Scripts/list-timezones.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists all available time zones
 .DESCRIPTION
-	list-timezones.ps1 
+	This script lists all available time zones.
 .EXAMPLE
 	PS> ./list-timezones

--- a/Scripts/list-tiobe-index.ps1
+++ b/Scripts/list-tiobe-index.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the TIOBE index of top programming languages
 .DESCRIPTION
-	list-tiobe-index.ps1 
+	This script lists the TIOBE index of top programming languages.
 .EXAMPLE
 	PS> ./list-tiobe-index
 .NOTES
--- a/Scripts/list-unused-files.ps1
+++ b/Scripts/list-unused-files.ps1
@@ -2,10 +2,11 @@
 .SYNOPSIS
 	Lists unused files in a folder (including subfolders)
 .DESCRIPTION
-	Lists files in a folder with last access time older than <Days>
-	list-unused-files.ps1 <DirTree> <Days>
-	<DirTree> is the path to the directory tree
-	<Days> is the number of days
+	This script scans and lists files in a folder with last access time older than number of days.
+.PARAMETER DirTree
+	Specifies the path to the directory tree
+.PARAMETER Days
+	Specifies the number of days
 .EXAMPLE
 	PS> ./list-unused-files C:\ 100
 .NOTES
--- a/Scripts/list-user-groups.ps1
+++ b/Scripts/list-user-groups.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the user groups on the local computer
 .DESCRIPTION
-	list-user-groups.ps1 
+	This script lists the user groups on the local computer.
 .EXAMPLE
 	PS> ./list-user-groups

--- a/Scripts/list-weather.ps1
+++ b/Scripts/list-weather.ps1
@@ -2,7 +2,9 @@
 .SYNOPSIS
 	Lists the hourly weather report
 .DESCRIPTION
-	list-weather.ps1 [<Location>]
+	This script lists the hourly weather report.
+.PARAMETER Location
+	Specifies the location to use (determined automatically per default)
 .EXAMPLE
 	PS> ./list-weather
 .NOTES
--- a/Scripts/list-workdir.ps1
+++ b/Scripts/list-workdir.ps1
@@ -2,7 +2,7 @@
 .SYNOPSIS
 	Lists the current working directory
 .DESCRIPTION
-	list-workdir.ps1 
+	This script lists the current working directory (but not the content itself!)
 .EXAMPLE
 	PS> ./list-workdir
 .NOTES