Update the comment based help

This commit is contained in:
Markus Fleschutz 2021-10-16 13:40:20 +02:00
parent 053b26c578
commit c296024b8f
58 changed files with 105 additions and 81 deletions

View File

@ -1,6 +1,6 @@
## list-aliases.ps1 - Lists all PowerShell aliases
list-aliases.ps1
This scripts lists all PowerShell aliases.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## list-anagrams.ps1 - Lists all anagrams of the given word
list-anagrams.ps1 [<word>] [<columns>]
This script lists all anagrams of the given word.
## Parameters
```powershell
list-anagrams.ps1 [[-Word] <String>] [[-Columns] <Int32>] [<CommonParameters>]
-Word <String>
Specifies the word to use
Required? false
Position? 1
@ -15,6 +16,7 @@ list-anagrams.ps1 [[-Word] <String>] [[-Columns] <Int32>] [<CommonParameters>]
Accept wildcard characters? false
-Columns <Int32>
Specifies the number of columns
Required? false
Position? 2

View File

@ -1,6 +1,6 @@
## list-branches.ps1 - Lists all branches in a Git repository
list-branches.ps1 [<RepoDir>] [<SearchPattern>]
This script lists all branches in a Git repository.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-cheat-sheet.ps1 - Lists the PowerShell cheat sheet
list-cheat-sheet.ps1
This script lists the PowerShell cheat sheet.
## Parameters
```powershell

View File

@ -1,7 +1,6 @@
## list-city-weather.ps1 - List the current weather of cities world-wide
## list-city-weather.ps1 - Lists current weather of cities world-wide
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).
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-clipboard.ps1 - Lists the contents of the clipboard
list-clipboard.ps1
This script lists the contents of the clipboard.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-cmdlets.ps1 - Lists all PowerShell cmdlets
list-cmdlets.ps1
This script lists all PowerShell cmdlets.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-commits.ps1 - Lists all commits in a Git repository
list-commits.ps1 [<RepoDir>] [<Format>]
This script lists all commits in a Git repository. Supported output formats are: list, compact, normal or JSON.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-console-colors.ps1 - Lists all console colors
list-console-colors.ps1
This script lists all available console colors.
## Parameters
```powershell
@ -14,6 +14,12 @@ list-console-colors.ps1 [<CommonParameters>]
## Example
```powershell
PS>./list-console-colors
Name Foreground Background
---- ---------- ----------
...
```
## Notes

View File

@ -1,6 +1,6 @@
## list-credits.ps1 - Shows the credits for the PowerShell Scripts
list-credits.ps1
This script shows the credits for the PowerShell Scripts.
## Parameters
```powershell

View File

@ -1,13 +1,13 @@
## list-dir-tree.ps1 - Lists the full directory tree
list-dir-tree.ps1 [<DirTree>]
<DirTree> is the path to the directory tree
This script lists the full directory tree.
## Parameters
```powershell
list-dir-tree.ps1 [[-DirTree] <String>] [<CommonParameters>]
-DirTree <String>
Specifies the path to the directory tree
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## list-earthquakes.ps1 - Lists major earthquakes for the last 30 days
## list-earthquakes.ps1 - Lists major earthquakes since 30 days
Lists earthquakes with magnitude >= 6.0 for the last 30 days
This script lists earthquakes with magnitude >= 6.0 for the last 30 days.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-emojis.ps1 - Lists the Emojis of Unicode 13.0
list-emojis.ps1
This script lists the emojis of Unicode 13.0 sorted by category.
## Parameters
```powershell

View File

@ -1,7 +1,6 @@
## list-installed-software.ps1 - Lists the installed software
Lists the installed software (except Windows Store apps)
list-installed-software.ps1
This script lists the installed software (except Windows Store apps).
## Parameters
```powershell

View File

@ -1,13 +1,13 @@
## list-latest-tag.ps1 - Lists the latest tag on the current branch in a Git repository
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.
## Parameters
```powershell
list-latest-tag.ps1 [[-RepoDir] <String>] [<CommonParameters>]
-RepoDir <String>
Specifies the path to the repository
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## list-recycle-bin.ps1 - Lists the content of the recycle bin folder
list-recycle-bin.ps1
This script lists the content of the recycle bin folder.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-system-info.ps1 - Lists system information of the local computer
list-system-info.ps1
This script lists system information of the local computer.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-timezone.ps1 - Lists the details of the current time zone
list-timezone.ps1
This script lists the details of the current time zone.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## list-timezones.ps1 - Lists all available time zones
list-timezones.ps1
This script lists all available time zones.
## Parameters
```powershell

View File

@ -1,15 +1,13 @@
## list-unused-files.ps1 - Lists unused files in a folder (including subfolders)
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.
## Parameters
```powershell
list-unused-files.ps1 [[-DirTree] <String>] [[-Days] <Int32>] [<CommonParameters>]
-DirTree <String>
Specifies the path to the directory tree
Required? false
Position? 1
@ -18,6 +16,7 @@ list-unused-files.ps1 [[-DirTree] <String>] [[-Days] <Int32>] [<CommonParameters
Accept wildcard characters? false
-Days <Int32>
Specifies the number of days
Required? false
Position? 2

View File

@ -1,6 +1,6 @@
## list-user-groups.ps1 - Lists the user groups on the local computer
list-user-groups.ps1
This script lists the user groups on the local computer.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## list-weather.ps1 - Lists the hourly weather report
list-weather.ps1 [<Location>]
This script lists the hourly weather report.
## Parameters
```powershell
list-weather.ps1 [[-Location] <String>] [<CommonParameters>]
-Location <String>
Specifies the location to use (determined automatically per default)
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## list-workdir.ps1 - Lists the current working directory
list-workdir.ps1
This script lists the current working directory (but not the content itself!)
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## speak-countdown.ps1 - Speaks a countdown by text-to-speech (TTS)
## speak-countdown.ps1 - Speaks a countdown by text-to-speech
speak-countdown.ps1 [StartNumber]
This scripts speaks a countdown by text-to-speech (TTS).
## Parameters
```powershell
speak-countdown.ps1 [[-StartNumber] <Int32>] [<CommonParameters>]
-StartNumber <Int32>
Specifies the number to start from
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## speak-english.ps1 - Speaks the given text with an English text-to-speech (TTS) voice
## speak-english.ps1 - Speaks text with an English text-to-speech voice
speak-english.ps1 [<text>]
This scripts speaks the given text with an English text-to-speech (TTS) voice.
## Parameters
```powershell
speak-english.ps1 [[-text] <String>] [<CommonParameters>]
-text <String>
Specifies the text to speak
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## speak-french.ps1 - Speaks the given text with a French text-to-speech (TTS) voice
## speak-french.ps1 - Speaks text with a French text-to-speech voice
speak-french.ps1 [<text>]
This script speaks the given text with a French text-to-speech (TTS) voice
## Parameters
```powershell
speak-french.ps1 [[-text] <String>] [<CommonParameters>]
-text <String>
Specifies the text to speak
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## speak-german.ps1 - Speaks the given text with a German text-to-speech (TTS) voice
## speak-german.ps1 - Speaks text with a German text-to-speech voice
speak-german.ps1 [<text>]
This script speaks the given text with a German text-to-speech (TTS) voice.
## Parameters
```powershell
speak-german.ps1 [[-text] <String>] [<CommonParameters>]
-text <String>
Specifies the text to speak
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## speak-italian.ps1 - Speaks the given text with an Italian text-to-speech (TTS) voice
## speak-italian.ps1 - Speaks text with an Italian text-to-speech voice
speak-italian.ps1 [<text>]
This script speaks the given text with an Italian text-to-speech (TTS) voice.
## Parameters
```powershell
speak-italian.ps1 [[-text] <String>] [<CommonParameters>]
-text <String>
Specifies the text to speak
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## speak-spanish.ps1 - Speaks the given text with a Spanish text-to-speech (TTS) voice
## speak-spanish.ps1 - Speaks text with a Spanish text-to-speech voice
speak-spanish.ps1 [<text>]
This script speaks the given text with a Spanish text-to-speech (TTS) voice.
## Parameters
```powershell
speak-spanish.ps1 [[-text] <String>] [<CommonParameters>]
-text <String>
Specifies the text to speak
Required? false
Position? 1

View File

@ -7,6 +7,7 @@ speak-text.ps1 [<text>]
speak-text.ps1 [[-text] <String>] [<CommonParameters>]
-text <String>
Specifies the text to speak
Required? false
Position? 1

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all PowerShell aliases
.DESCRIPTION
list-aliases.ps1
This scripts lists all PowerShell aliases.
.EXAMPLE
PS> ./list-aliases

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -2,7 +2,7 @@
.SYNOPSIS
Lists all PowerShell cmdlets
.DESCRIPTION
list-cmdlets.ps1
This script lists all PowerShell cmdlets.
.EXAMPLE
PS> ./list-cmdlets

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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