Update manuals

This commit is contained in:
Markus Fleschutz 2021-10-16 12:02:47 +02:00
parent 4ca038db30
commit 09aa1fee33
35 changed files with 125 additions and 50 deletions

View File

@ -1,23 +1,34 @@
## export-to-serenade.ps1 - Exports all scripts to Serenade for voice control ## export-to-serenade.ps1 - Exports all scripts to Serenade for voice control
This script exports all PowerShell scripts to Serenade.ai for voice control. This script exports all PowerShell scripts to Serenade to execute them by voice.
## Parameters ## Parameters
```powershell ```powershell
export-to-serenade.ps1 [[-FilePattern] <String>] [[-TargetFile] <String>] [<CommonParameters>] export-to-serenade.ps1 [[-WakeWord] <String>] [[-FilePattern] <String>] [[-TargetFile] <String>] [<CommonParameters>]
-FilePattern <String> -WakeWord <String>
Specifies the wakeword (none by default)
Required? false Required? false
Position? 1 Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FilePattern <String>
Specifies the file pattern for the scripts ("$PSScriptRoot/*.ps1" by default)
Required? false
Position? 2
Default value "$PSScriptRoot/*.ps1" Default value "$PSScriptRoot/*.ps1"
Accept pipeline input? false Accept pipeline input? false
Accept wildcard characters? false Accept wildcard characters? false
-TargetFile <String> -TargetFile <String>
Specifies the target file ("$HOME/.serenade/scripts/PowerShell.js" by default)
Required? false Required? false
Position? 2 Position? 3
Default value "$HOME/.serenade/scripts/PowerShell.js" Default value "$HOME/.serenade/scripts/PowerShell.js"
Accept pipeline input? false Accept pipeline input? false
Accept wildcard characters? false Accept wildcard characters? false
@ -29,7 +40,7 @@ export-to-serenade.ps1 [[-FilePattern] <String>] [[-TargetFile] <String>] [<Comm
## Example ## Example
```powershell ```powershell
PS>./export-to-serenade.ps1 PS>./export-to-serenade.ps1 Computer
Exporting 264 scripts to C:\Users\Markus/.serenade/scripts/PowerShell.js... Exporting 264 scripts to C:\Users\Markus/.serenade/scripts/PowerShell.js...
✔️ exported 264 PowerShell scripts to Serenade in 22 sec ✔️ exported 264 PowerShell scripts to Serenade in 22 sec
``` ```

View File

@ -1,14 +1,13 @@
## list-branches.ps1 - Lists all branches in a Git repository ## list-branches.ps1 - Lists all branches in a Git repository
list-branches.ps1 [<RepoDir>] [<SearchPattern>] list-branches.ps1 [<RepoDir>] [<SearchPattern>]
<RepoDir> is the current working directory by default
<SearchPattern> is "*" (anything) by default
## Parameters ## Parameters
```powershell ```powershell
list-branches.ps1 [[-RepoDir] <String>] [[-SearchPattern] <String>] [<CommonParameters>] list-branches.ps1 [[-RepoDir] <String>] [[-SearchPattern] <String>] [<CommonParameters>]
-RepoDir <String> -RepoDir <String>
Specifies the path to the Git repository (current working directory by default)
Required? false Required? false
Position? 1 Position? 1
@ -17,6 +16,7 @@ list-branches.ps1 [[-RepoDir] <String>] [[-SearchPattern] <String>] [<CommonPara
Accept wildcard characters? false Accept wildcard characters? false
-SearchPattern <String> -SearchPattern <String>
Specifies the search patter (anything by default)
Required? false Required? false
Position? 2 Position? 2

View File

@ -1,6 +1,6 @@
## list-drives.ps1 - Lists all local drives. ## list-drives.ps1 - Lists all local drives
list-drives.ps1 This script lists the details of all local drives.
## Parameters ## Parameters
```powershell ```powershell

View File

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

View File

@ -1,13 +1,13 @@
## list-empty-dirs.ps1 - Lists empty subfolders within a directory tree ## list-empty-dirs.ps1 - Lists empty subfolders within a directory tree
list-empty-dirs.ps1 [<DirTree>] This script scans and lists all empty subfolders within the given directory tree.
<DirTree> is the path to the directory tree
## Parameters ## Parameters
```powershell ```powershell
list-empty-dirs.ps1 [[-DirTree] <String>] [<CommonParameters>] list-empty-dirs.ps1 [[-DirTree] <String>] [<CommonParameters>]
-DirTree <String> -DirTree <String>
Specifies the path to the directory tree
Required? false Required? false
Position? 1 Position? 1

View File

@ -1,13 +1,13 @@
## list-empty-files.ps1 - Lists empty files within a directory tree ## list-empty-files.ps1 - Lists empty files within a directory tree
list-empty-files.ps1 [<DirTree>] This script scans and lists all empty files within the given directory tree.
<DirTree> is the path to the directory tree
## Parameters ## Parameters
```powershell ```powershell
list-empty-files.ps1 [[-DirTree] <String>] [<CommonParameters>] list-empty-files.ps1 [[-DirTree] <String>] [<CommonParameters>]
-DirTree <String> -DirTree <String>
Specifies the path to the directory tree
Required? false Required? false
Position? 1 Position? 1

View File

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

View File

@ -1,13 +1,13 @@
## list-exchange-rates.ps1 - Lists the exchange rates for a currency ## list-exchange-rates.ps1 - Lists the exchange rates for a currency
Lists the current exchange rates for the given currency (USD per default). Lists the current exchange rates for the given currency (USD per default).
list-exchange-rates.ps1 [<currency>]
## Parameters ## Parameters
```powershell ```powershell
list-exchange-rates.ps1 [[-currency] <String>] [<CommonParameters>] list-exchange-rates.ps1 [[-currency] <String>] [<CommonParameters>]
-currency <String> -currency <String>
Specifies the base currency
Required? false Required? false
Position? 1 Position? 1

View File

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

View File

@ -1,12 +1,13 @@
## list-fritzbox-calls.ps1 - Lists the phone calls of the FRITZ!Box device ## list-fritzbox-calls.ps1 - Lists the phone calls of the FRITZ!Box device
list-fritzbox-calls.ps1 [<Username>] [<Password>] This script lists the phone calls of the FRITZ!Box device.
## Parameters ## Parameters
```powershell ```powershell
list-fritzbox-calls.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParameters>] list-fritzbox-calls.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParameters>]
-Username <String> -Username <String>
Specifies the user name for FRITZ!Box
Required? false Required? false
Position? 1 Position? 1
@ -15,6 +16,7 @@ list-fritzbox-calls.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonPa
Accept wildcard characters? false Accept wildcard characters? false
-Password <String> -Password <String>
Specifies the password to FRITZ!Box
Required? false Required? false
Position? 2 Position? 2

View File

@ -1,12 +1,13 @@
## list-fritzbox-devices.ps1 - Lists FRITZ!Box's known devices ## list-fritzbox-devices.ps1 - Lists FRITZ!Box's known devices
list-fritzbox-devices.ps1 [<Username>] [<Password>] This script lists FRITZ!Box's known devices.
## Parameters ## Parameters
```powershell ```powershell
list-fritzbox-devices.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParameters>] list-fritzbox-devices.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParameters>]
-Username <String> -Username <String>
Specifies the user name to FRITZ!Box
Required? false Required? false
Position? 1 Position? 1
@ -15,6 +16,7 @@ list-fritzbox-devices.ps1 [[-Username] <String>] [[-Password] <String>] [<Common
Accept wildcard characters? false Accept wildcard characters? false
-Password <String> -Password <String>
Specifies the password to FRITZ!Box
Required? false Required? false
Position? 2 Position? 2

View File

@ -1,13 +1,13 @@
## list-hidden-files.ps1 - Lists hidden files in a directory tree ## list-hidden-files.ps1 - Lists hidden files in a directory tree
list-hidden-files.ps1 [<DirTree>] This script scans and lists all hidden files in a directory tree.
<DirTree> is the path to the directory tree
## Parameters ## Parameters
```powershell ```powershell
list-hidden-files.ps1 [[-DirTree] <String>] [<CommonParameters>] list-hidden-files.ps1 [[-DirTree] <String>] [<CommonParameters>]
-DirTree <String> -DirTree <String>
Specifies the path to the directory tree
Required? false Required? false
Position? 1 Position? 1

View File

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

View File

@ -1,12 +1,13 @@
## list-latest-tags.ps1 - Lists the latests tags in all Git repositories in a folder ## list-latest-tags.ps1 - Lists the latests tags in all Git repositories in a folder
list-latest-tags.ps1 [<ParentDir>] This script lists the latest tags in all Git repositories in the specified folder.
## Parameters ## Parameters
```powershell ```powershell
list-latest-tags.ps1 [[-ParentDir] <String>] [<CommonParameters>] list-latest-tags.ps1 [[-ParentDir] <String>] [<CommonParameters>]
-ParentDir <String> -ParentDir <String>
Specifies the path to the parent folder
Required? false Required? false
Position? 1 Position? 1

View File

@ -1,6 +1,6 @@
## list-memos.ps1 - Lists all memos in $HOME/Memos.csv ## list-memos.ps1 - Lists all memos in $HOME/Memos.csv
list-memos.ps1 This script lists all memo entries in Memos.csv in the home folder.
## Parameters ## Parameters
```powershell ```powershell

View File

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

View File

@ -1,6 +1,6 @@
## list-mysql-tables.ps1 - Lists all tables of a MySQL database ## list-mysql-tables.ps1 - Lists all tables of a MySQL database
list-mysql-tables.ps1 This script lists all tables of the given MySQL database.
## Parameters ## Parameters
```powershell ```powershell

View File

@ -1,6 +1,6 @@
## list-network-shares.ps1 - Lists all network shares of the local computer ## list-network-shares.ps1 - Lists all network shares of the local computer
list-network-shares.ps1 This script lists all network shares of the local computer.
## Parameters ## Parameters
```powershell ```powershell

View File

@ -1,12 +1,13 @@
## list-news.ps1 - Lists the latest news ## list-news.ps1 - Lists the latest news
list-news.ps1 [<RSS-URL>] [<max-count>] This script lists the latest RSS feed news.
## Parameters ## Parameters
```powershell ```powershell
list-news.ps1 [[-RSS_URL] <String>] [[-MaxCount] <Int32>] [<CommonParameters>] list-news.ps1 [[-RSS_URL] <String>] [[-MaxCount] <Int32>] [<CommonParameters>]
-RSS_URL <String> -RSS_URL <String>
Specifies the URL to the RSS feed
Required? false Required? false
Position? 1 Position? 1
@ -15,6 +16,7 @@ list-news.ps1 [[-RSS_URL] <String>] [[-MaxCount] <Int32>] [<CommonParameters>]
Accept wildcard characters? false Accept wildcard characters? false
-MaxCount <Int32> -MaxCount <Int32>
Specifies the number of news to list
Required? false Required? false
Position? 2 Position? 2

View File

@ -1,6 +1,6 @@
## list-os-releases.ps1 - Lists OS releases and download URL ## list-os-releases.ps1 - Lists OS releases and download URL
list-os-releases.ps1 This script lists OS releases and download URL.
## Parameters ## Parameters
```powershell ```powershell

View File

@ -1,12 +1,13 @@
## list-os-updates.ps1 - Lists the latest operating system updates ## list-os-updates.ps1 - Lists the latest operating system updates
list-os-updates.ps1 [<RSS-URL>] [<max-count>] This script lists the latest operating system update news.
## Parameters ## Parameters
```powershell ```powershell
list-os-updates.ps1 [[-RSS_URL] <String>] [[-MaxCount] <Int32>] [<CommonParameters>] list-os-updates.ps1 [[-RSS_URL] <String>] [[-MaxCount] <Int32>] [<CommonParameters>]
-RSS_URL <String> -RSS_URL <String>
Specifies the URL to the RSS feed
Required? false Required? false
Position? 1 Position? 1
@ -15,6 +16,7 @@ list-os-updates.ps1 [[-RSS_URL] <String>] [[-MaxCount] <Int32>] [<CommonParamete
Accept wildcard characters? false Accept wildcard characters? false
-MaxCount <Int32> -MaxCount <Int32>
Specifies the number of news to list
Required? false Required? false
Position? 2 Position? 2

View File

@ -1,12 +1,13 @@
## list-passwords.ps1 - Prints a list of random passwords ## list-passwords.ps1 - Lists random passwords
list-passwords.ps1 [<PasswordLength>] [<Columns>] [<Rows>] This script lists random passwords.
## Parameters ## Parameters
```powershell ```powershell
list-passwords.ps1 [[-PasswordLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <Int32>] [<CommonParameters>] list-passwords.ps1 [[-PasswordLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <Int32>] [<CommonParameters>]
-PasswordLength <Int32> -PasswordLength <Int32>
Specifies the length of the password
Required? false Required? false
Position? 1 Position? 1
@ -15,6 +16,7 @@ list-passwords.ps1 [[-PasswordLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <In
Accept wildcard characters? false Accept wildcard characters? false
-Columns <Int32> -Columns <Int32>
Specifies the number of columns
Required? false Required? false
Position? 2 Position? 2
@ -23,6 +25,7 @@ list-passwords.ps1 [[-PasswordLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <In
Accept wildcard characters? false Accept wildcard characters? false
-Rows <Int32> -Rows <Int32>
Specifies the number of rows
Required? false Required? false
Position? 3 Position? 3

View File

@ -1,12 +1,13 @@
## list-pins.ps1 - Prints a list of random PIN's ## list-pins.ps1 - Lists random PIN's
list-pins.ps1 [<PinLength>] [<Columns>] [<Rows>] This script lists random PIN's.
## Parameters ## Parameters
```powershell ```powershell
list-pins.ps1 [[-PinLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <Int32>] [<CommonParameters>] list-pins.ps1 [[-PinLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <Int32>] [<CommonParameters>]
-PinLength <Int32> -PinLength <Int32>
Specifies the PIN length
Required? false Required? false
Position? 1 Position? 1
@ -15,6 +16,7 @@ list-pins.ps1 [[-PinLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <Int32>] [<Co
Accept wildcard characters? false Accept wildcard characters? false
-Columns <Int32> -Columns <Int32>
Specifies the number of columns
Required? false Required? false
Position? 2 Position? 2
@ -23,6 +25,7 @@ list-pins.ps1 [[-PinLength] <Int32>] [[-Columns] <Int32>] [[-Rows] <Int32>] [<Co
Accept wildcard characters? false Accept wildcard characters? false
-Rows <Int32> -Rows <Int32>
Specifies the number of rows
Required? false Required? false
Position? 3 Position? 3

View File

@ -1,6 +1,6 @@
## list-print-jobs.ps1 - Lists all jobs of all printers ## list-print-jobs.ps1 - Lists all jobs of all printers
list-print-jobs.ps1 This script lists all print jobs of all printer devices.
## Parameters ## Parameters
```powershell ```powershell

View File

@ -1,6 +1,6 @@
## list-printers.ps1 - Lists all printers known to the local computer ## list-printers.ps1 - Lists all printers known to the local computer
list-printers.ps1 This script lists all printers known to the local computer.
## Parameters ## Parameters
```powershell ```powershell

View File

@ -1,6 +1,6 @@
## list-processes.ps1 - Lists all local computer processes ## list-processes.ps1 - Lists all local computer processes
list-processes.ps1 This script lists all local computer processes.
## Parameters ## Parameters
```powershell ```powershell

View File

@ -1,12 +1,13 @@
## list-repos.ps1 - Lists the details of all Git repositories in a folder ## list-repos.ps1 - Lists the details of all Git repositories in a folder
list-repos.ps1 [<ParentDir>] This script lists the details of all Git repositories in the given folder.
## Parameters ## Parameters
```powershell ```powershell
list-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>] list-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
-ParentDir <String> -ParentDir <String>
Specifies the path to the parent folder.
Required? false Required? false
Position? 1 Position? 1

View File

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

View File

@ -1,7 +1,6 @@
## list-sql-tables.ps1 - Lists all tables of a SQL server database ## list-sql-tables.ps1 - Lists all tables of a SQL server database
Lists all tables in a SQL server database and exports the list as CSV Lists all tables in a SQL server database and exports the list as CSV.
Install-Module InvokeQuery Install-Module InvokeQuery
Run the above command if you do not have this module. Run the above command if you do not have this module.

View File

@ -1,13 +1,13 @@
## list-submodules.ps1 - Lists the submodules of a Git repository ## list-submodules.ps1 - Lists the submodules of a Git repository
list-submodules.ps1 [<RepoDir>] This script lists the submodules of the given Git repository.
<RepoDir> is the path to the repository (current working dir by default)
## Parameters ## Parameters
```powershell ```powershell
list-submodules.ps1 [[-RepoDir] <String>] [<CommonParameters>] list-submodules.ps1 [[-RepoDir] <String>] [<CommonParameters>]
-RepoDir <String> -RepoDir <String>
Specifies the path to the repository (current working dir by default)
Required? false Required? false
Position? 1 Position? 1

View File

@ -1,14 +1,13 @@
## list-tags.ps1 - Lists all tags in a Git repository ## list-tags.ps1 - Lists all tags in a Git repository
list-tags.ps1 [<RepoDir>] [<SearchPattern>] This script lists all tags in the given Git repository.
<RepoDir> is the path to the Git repository
<SearchPattern> is "*" (anything) by default
## Parameters ## Parameters
```powershell ```powershell
list-tags.ps1 [[-RepoDir] <String>] [[-SearchPattern] <String>] [<CommonParameters>] list-tags.ps1 [[-RepoDir] <String>] [[-SearchPattern] <String>] [<CommonParameters>]
-RepoDir <String> -RepoDir <String>
Specifies the path to the Git repository
Required? false Required? false
Position? 1 Position? 1
@ -17,6 +16,7 @@ list-tags.ps1 [[-RepoDir] <String>] [[-SearchPattern] <String>] [<CommonParamete
Accept wildcard characters? false Accept wildcard characters? false
-SearchPattern <String> -SearchPattern <String>
Specifies the search pattern (anything by default)
Required? false Required? false
Position? 2 Position? 2

View File

@ -1,6 +1,6 @@
## list-tasks.ps1 - Lists all Windows scheduler tasks ## list-tasks.ps1 - Lists all Windows scheduler tasks
list-tasks.ps1 This script lists all Windows scheduler tasks.
## Parameters ## Parameters
```powershell ```powershell

View File

@ -0,0 +1,26 @@
## say-operating-system.ps1 - Say the operating system details by text-to-speech
This script speaks the operating system details by text-to-speech (TTS).
## Parameters
```powershell
say-operating-system.ps1 [<CommonParameters>]
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS>./say-operating-system
(listen)
```
## Notes
Author: Markus Fleschutz · License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of say-operating-system.ps1*

25
Docs/thank-you.md Normal file
View File

@ -0,0 +1,25 @@
## thank-you.ps1 - Say an answer to 'thank you'
This script answers to "thank you" by text-to-speech (TTS).
## Parameters
```powershell
thank-you.ps1 [<CommonParameters>]
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS>./thank-you
```
## Notes
Author: Markus Fleschutz · License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of thank-you.ps1*

View File

@ -21,7 +21,7 @@ try {
$StopWatch = [system.diagnostics.stopwatch]::startNew() $StopWatch = [system.diagnostics.stopwatch]::startNew()
$Scripts = Get-ChildItem "$FilePattern" $Scripts = Get-ChildItem "$FilePattern"
"Found $($Scripts.Count) scripts, exporting to $TargetDir..." "⏳ Exporting $($Scripts.Count) scripts to $TargetDir..."
foreach ($Script in $Scripts) { foreach ($Script in $Scripts) {
& "$PSScriptRoot/convert-ps2md" "$Script" > "$TargetDir/$($Script.BaseName).md" & "$PSScriptRoot/convert-ps2md" "$Script" > "$TargetDir/$($Script.BaseName).md"