From 09aa1fee33b6e23a7ac5c4b18013cadf5a872295 Mon Sep 17 00:00:00 2001 From: Markus Fleschutz Date: Sat, 16 Oct 2021 12:02:47 +0200 Subject: [PATCH] Update manuals --- Docs/export-to-serenade.md | 21 ++++++++++++++++----- Docs/list-branches.md | 4 ++-- Docs/list-drives.md | 4 ++-- Docs/list-earthquakes.md | 1 - Docs/list-empty-dirs.md | 4 ++-- Docs/list-empty-files.md | 4 ++-- Docs/list-environment-variables.md | 2 +- Docs/list-exchange-rates.md | 2 +- Docs/list-files.md | 4 ++-- Docs/list-fritzbox-calls.md | 4 +++- Docs/list-fritzbox-devices.md | 4 +++- Docs/list-hidden-files.md | 4 ++-- Docs/list-installed-apps.md | 3 +-- Docs/list-latest-tags.md | 3 ++- Docs/list-memos.md | 2 +- Docs/list-modules.md | 2 +- Docs/list-mysql-tables.md | 2 +- Docs/list-network-shares.md | 2 +- Docs/list-news.md | 4 +++- Docs/list-os-releases.md | 2 +- Docs/list-os-updates.md | 4 +++- Docs/list-passwords.md | 7 +++++-- Docs/list-pins.md | 7 +++++-- Docs/list-print-jobs.md | 2 +- Docs/list-printers.md | 2 +- Docs/list-processes.md | 2 +- Docs/list-repos.md | 3 ++- Docs/list-services.md | 2 +- Docs/list-sql-tables.md | 3 +-- Docs/list-submodules.md | 4 ++-- Docs/list-tags.md | 6 +++--- Docs/list-tasks.md | 2 +- Docs/say-operating-system.md | 26 ++++++++++++++++++++++++++ Docs/thank-you.md | 25 +++++++++++++++++++++++++ Scripts/export-to-manuals.ps1 | 2 +- 35 files changed, 125 insertions(+), 50 deletions(-) create mode 100644 Docs/say-operating-system.md create mode 100644 Docs/thank-you.md diff --git a/Docs/export-to-serenade.md b/Docs/export-to-serenade.md index 4c218440..fee89d87 100644 --- a/Docs/export-to-serenade.md +++ b/Docs/export-to-serenade.md @@ -1,23 +1,34 @@ ## 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 ```powershell -export-to-serenade.ps1 [[-FilePattern] ] [[-TargetFile] ] [] +export-to-serenade.ps1 [[-WakeWord] ] [[-FilePattern] ] [[-TargetFile] ] [] --FilePattern +-WakeWord + Specifies the wakeword (none by default) Required? false Position? 1 + Default value + Accept pipeline input? false + Accept wildcard characters? false + +-FilePattern + Specifies the file pattern for the scripts ("$PSScriptRoot/*.ps1" by default) + + Required? false + Position? 2 Default value "$PSScriptRoot/*.ps1" Accept pipeline input? false Accept wildcard characters? false -TargetFile + Specifies the target file ("$HOME/.serenade/scripts/PowerShell.js" by default) Required? false - Position? 2 + Position? 3 Default value "$HOME/.serenade/scripts/PowerShell.js" Accept pipeline input? false Accept wildcard characters? false @@ -29,7 +40,7 @@ export-to-serenade.ps1 [[-FilePattern] ] [[-TargetFile] ] [./export-to-serenade.ps1 +PS>./export-to-serenade.ps1 Computer Exporting 264 scripts to C:\Users\Markus/.serenade/scripts/PowerShell.js... ✔️ exported 264 PowerShell scripts to Serenade in 22 sec ``` diff --git a/Docs/list-branches.md b/Docs/list-branches.md index eb68192a..756d9394 100644 --- a/Docs/list-branches.md +++ b/Docs/list-branches.md @@ -1,14 +1,13 @@ ## list-branches.ps1 - Lists all branches in a Git repository list-branches.ps1 [] [] - is the current working directory by default - is "*" (anything) by default ## Parameters ```powershell list-branches.ps1 [[-RepoDir] ] [[-SearchPattern] ] [] -RepoDir + Specifies the path to the Git repository (current working directory by default) Required? false Position? 1 @@ -17,6 +16,7 @@ list-branches.ps1 [[-RepoDir] ] [[-SearchPattern] ] [ + Specifies the search patter (anything by default) Required? false Position? 2 diff --git a/Docs/list-drives.md b/Docs/list-drives.md index 569718b7..34cc2ece 100644 --- a/Docs/list-drives.md +++ b/Docs/list-drives.md @@ -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 ```powershell diff --git a/Docs/list-earthquakes.md b/Docs/list-earthquakes.md index dd458dc8..dd376500 100644 --- a/Docs/list-earthquakes.md +++ b/Docs/list-earthquakes.md @@ -1,7 +1,6 @@ ## list-earthquakes.ps1 - Lists major earthquakes for the last 30 days Lists earthquakes with magnitude >= 6.0 for the last 30 days -list-earthquakes.ps1 ## Parameters ```powershell diff --git a/Docs/list-empty-dirs.md b/Docs/list-empty-dirs.md index 40bd5c52..91a5b7d0 100644 --- a/Docs/list-empty-dirs.md +++ b/Docs/list-empty-dirs.md @@ -1,13 +1,13 @@ ## list-empty-dirs.ps1 - Lists empty subfolders within a directory tree -list-empty-dirs.ps1 [] - is the path to the directory tree +This script scans and lists all empty subfolders within the given directory tree. ## Parameters ```powershell list-empty-dirs.ps1 [[-DirTree] ] [] -DirTree + Specifies the path to the directory tree Required? false Position? 1 diff --git a/Docs/list-empty-files.md b/Docs/list-empty-files.md index 49e8c2ac..d959b7cf 100644 --- a/Docs/list-empty-files.md +++ b/Docs/list-empty-files.md @@ -1,13 +1,13 @@ ## list-empty-files.ps1 - Lists empty files within a directory tree -list-empty-files.ps1 [] - is the path to the directory tree +This script scans and lists all empty files within the given directory tree. ## Parameters ```powershell list-empty-files.ps1 [[-DirTree] ] [] -DirTree + Specifies the path to the directory tree Required? false Position? 1 diff --git a/Docs/list-environment-variables.md b/Docs/list-environment-variables.md index 7e6bd722..2fbb72aa 100644 --- a/Docs/list-environment-variables.md +++ b/Docs/list-environment-variables.md @@ -1,6 +1,6 @@ ## list-environment-variables.ps1 - Lists all environment variables -list-environment-variables.ps1 +This script lists all environment variables. ## Parameters ```powershell diff --git a/Docs/list-exchange-rates.md b/Docs/list-exchange-rates.md index c243c8fc..f49ac6cb 100644 --- a/Docs/list-exchange-rates.md +++ b/Docs/list-exchange-rates.md @@ -1,13 +1,13 @@ ## list-exchange-rates.ps1 - Lists the exchange rates for a currency Lists the current exchange rates for the given currency (USD per default). -list-exchange-rates.ps1 [] ## Parameters ```powershell list-exchange-rates.ps1 [[-currency] ] [] -currency + Specifies the base currency Required? false Position? 1 diff --git a/Docs/list-files.md b/Docs/list-files.md index cca324ad..9833ae59 100644 --- a/Docs/list-files.md +++ b/Docs/list-files.md @@ -1,13 +1,13 @@ ## list-files.ps1 - Lists all files in a directory tree -list-files.ps1 [] - is the path to the directory tree +This script lists all files within the given directory tree. ## Parameters ```powershell list-files.ps1 [[-DirTree] ] [] -DirTree + Specifies the path to the directory tree Required? false Position? 1 diff --git a/Docs/list-fritzbox-calls.md b/Docs/list-fritzbox-calls.md index 4a68909e..0941b1f0 100644 --- a/Docs/list-fritzbox-calls.md +++ b/Docs/list-fritzbox-calls.md @@ -1,12 +1,13 @@ ## list-fritzbox-calls.ps1 - Lists the phone calls of the FRITZ!Box device -list-fritzbox-calls.ps1 [] [] +This script lists the phone calls of the FRITZ!Box device. ## Parameters ```powershell list-fritzbox-calls.ps1 [[-Username] ] [[-Password] ] [] -Username + Specifies the user name for FRITZ!Box Required? false Position? 1 @@ -15,6 +16,7 @@ list-fritzbox-calls.ps1 [[-Username] ] [[-Password] ] [ + Specifies the password to FRITZ!Box Required? false Position? 2 diff --git a/Docs/list-fritzbox-devices.md b/Docs/list-fritzbox-devices.md index 22ac52fb..f0a26052 100644 --- a/Docs/list-fritzbox-devices.md +++ b/Docs/list-fritzbox-devices.md @@ -1,12 +1,13 @@ ## list-fritzbox-devices.ps1 - Lists FRITZ!Box's known devices -list-fritzbox-devices.ps1 [] [] +This script lists FRITZ!Box's known devices. ## Parameters ```powershell list-fritzbox-devices.ps1 [[-Username] ] [[-Password] ] [] -Username + Specifies the user name to FRITZ!Box Required? false Position? 1 @@ -15,6 +16,7 @@ list-fritzbox-devices.ps1 [[-Username] ] [[-Password] ] [ + Specifies the password to FRITZ!Box Required? false Position? 2 diff --git a/Docs/list-hidden-files.md b/Docs/list-hidden-files.md index 4b2f8fac..27c53f5a 100644 --- a/Docs/list-hidden-files.md +++ b/Docs/list-hidden-files.md @@ -1,13 +1,13 @@ ## list-hidden-files.ps1 - Lists hidden files in a directory tree -list-hidden-files.ps1 [] - is the path to the directory tree +This script scans and lists all hidden files in a directory tree. ## Parameters ```powershell list-hidden-files.ps1 [[-DirTree] ] [] -DirTree + Specifies the path to the directory tree Required? false Position? 1 diff --git a/Docs/list-installed-apps.md b/Docs/list-installed-apps.md index 1cc833d1..18204c22 100644 --- a/Docs/list-installed-apps.md +++ b/Docs/list-installed-apps.md @@ -1,7 +1,6 @@ ## list-installed-apps.ps1 - Lists the installed apps -Lists the installed apps (from Windows Store or snaps). -list-installed-apps.ps1 +This script lists the installed apps (from Windows Store or snaps). ## Parameters ```powershell diff --git a/Docs/list-latest-tags.md b/Docs/list-latest-tags.md index f4867f65..c082f83d 100644 --- a/Docs/list-latest-tags.md +++ b/Docs/list-latest-tags.md @@ -1,12 +1,13 @@ ## list-latest-tags.ps1 - Lists the latests tags in all Git repositories in a folder -list-latest-tags.ps1 [] +This script lists the latest tags in all Git repositories in the specified folder. ## Parameters ```powershell list-latest-tags.ps1 [[-ParentDir] ] [] -ParentDir + Specifies the path to the parent folder Required? false Position? 1 diff --git a/Docs/list-memos.md b/Docs/list-memos.md index e7577a08..063a5a96 100644 --- a/Docs/list-memos.md +++ b/Docs/list-memos.md @@ -1,6 +1,6 @@ ## 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 ```powershell diff --git a/Docs/list-modules.md b/Docs/list-modules.md index 9b1277dd..aed70cfb 100644 --- a/Docs/list-modules.md +++ b/Docs/list-modules.md @@ -1,6 +1,6 @@ ## list-modules.ps1 - Lists all PowerShell modules -list-modules.ps1 +This script lists all installed PowerShell modules. ## Parameters ```powershell diff --git a/Docs/list-mysql-tables.md b/Docs/list-mysql-tables.md index c2e2f006..2d2b1303 100644 --- a/Docs/list-mysql-tables.md +++ b/Docs/list-mysql-tables.md @@ -1,6 +1,6 @@ ## 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 ```powershell diff --git a/Docs/list-network-shares.md b/Docs/list-network-shares.md index 2a5b814c..a69b0515 100644 --- a/Docs/list-network-shares.md +++ b/Docs/list-network-shares.md @@ -1,6 +1,6 @@ ## 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 ```powershell diff --git a/Docs/list-news.md b/Docs/list-news.md index 295c02e7..8c6eac2f 100644 --- a/Docs/list-news.md +++ b/Docs/list-news.md @@ -1,12 +1,13 @@ ## list-news.ps1 - Lists the latest news -list-news.ps1 [] [] +This script lists the latest RSS feed news. ## Parameters ```powershell list-news.ps1 [[-RSS_URL] ] [[-MaxCount] ] [] -RSS_URL + Specifies the URL to the RSS feed Required? false Position? 1 @@ -15,6 +16,7 @@ list-news.ps1 [[-RSS_URL] ] [[-MaxCount] ] [] Accept wildcard characters? false -MaxCount + Specifies the number of news to list Required? false Position? 2 diff --git a/Docs/list-os-releases.md b/Docs/list-os-releases.md index bb766987..a772a42b 100644 --- a/Docs/list-os-releases.md +++ b/Docs/list-os-releases.md @@ -1,6 +1,6 @@ ## list-os-releases.ps1 - Lists OS releases and download URL -list-os-releases.ps1 +This script lists OS releases and download URL. ## Parameters ```powershell diff --git a/Docs/list-os-updates.md b/Docs/list-os-updates.md index 8594bdbc..cdf479d1 100644 --- a/Docs/list-os-updates.md +++ b/Docs/list-os-updates.md @@ -1,12 +1,13 @@ ## list-os-updates.ps1 - Lists the latest operating system updates -list-os-updates.ps1 [] [] +This script lists the latest operating system update news. ## Parameters ```powershell list-os-updates.ps1 [[-RSS_URL] ] [[-MaxCount] ] [] -RSS_URL + Specifies the URL to the RSS feed Required? false Position? 1 @@ -15,6 +16,7 @@ list-os-updates.ps1 [[-RSS_URL] ] [[-MaxCount] ] [ + Specifies the number of news to list Required? false Position? 2 diff --git a/Docs/list-passwords.md b/Docs/list-passwords.md index 985c6c09..aa483942 100644 --- a/Docs/list-passwords.md +++ b/Docs/list-passwords.md @@ -1,12 +1,13 @@ -## list-passwords.ps1 - Prints a list of random passwords +## list-passwords.ps1 - Lists random passwords -list-passwords.ps1 [] [] [] +This script lists random passwords. ## Parameters ```powershell list-passwords.ps1 [[-PasswordLength] ] [[-Columns] ] [[-Rows] ] [] -PasswordLength + Specifies the length of the password Required? false Position? 1 @@ -15,6 +16,7 @@ list-passwords.ps1 [[-PasswordLength] ] [[-Columns] ] [[-Rows] + Specifies the number of columns Required? false Position? 2 @@ -23,6 +25,7 @@ list-passwords.ps1 [[-PasswordLength] ] [[-Columns] ] [[-Rows] + Specifies the number of rows Required? false Position? 3 diff --git a/Docs/list-pins.md b/Docs/list-pins.md index 505b6214..3c4ddc01 100644 --- a/Docs/list-pins.md +++ b/Docs/list-pins.md @@ -1,12 +1,13 @@ -## list-pins.ps1 - Prints a list of random PIN's +## list-pins.ps1 - Lists random PIN's -list-pins.ps1 [] [] [] +This script lists random PIN's. ## Parameters ```powershell list-pins.ps1 [[-PinLength] ] [[-Columns] ] [[-Rows] ] [] -PinLength + Specifies the PIN length Required? false Position? 1 @@ -15,6 +16,7 @@ list-pins.ps1 [[-PinLength] ] [[-Columns] ] [[-Rows] ] [ + Specifies the number of columns Required? false Position? 2 @@ -23,6 +25,7 @@ list-pins.ps1 [[-PinLength] ] [[-Columns] ] [[-Rows] ] [ + Specifies the number of rows Required? false Position? 3 diff --git a/Docs/list-print-jobs.md b/Docs/list-print-jobs.md index 3c86c770..5131517f 100644 --- a/Docs/list-print-jobs.md +++ b/Docs/list-print-jobs.md @@ -1,6 +1,6 @@ ## 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 ```powershell diff --git a/Docs/list-printers.md b/Docs/list-printers.md index 46e0e9bb..1085e048 100644 --- a/Docs/list-printers.md +++ b/Docs/list-printers.md @@ -1,6 +1,6 @@ ## 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 ```powershell diff --git a/Docs/list-processes.md b/Docs/list-processes.md index f4778ac4..2739da88 100644 --- a/Docs/list-processes.md +++ b/Docs/list-processes.md @@ -1,6 +1,6 @@ ## list-processes.ps1 - Lists all local computer processes -list-processes.ps1 +This script lists all local computer processes. ## Parameters ```powershell diff --git a/Docs/list-repos.md b/Docs/list-repos.md index 9f932907..989cc62f 100644 --- a/Docs/list-repos.md +++ b/Docs/list-repos.md @@ -1,12 +1,13 @@ ## list-repos.ps1 - Lists the details of all Git repositories in a folder -list-repos.ps1 [] +This script lists the details of all Git repositories in the given folder. ## Parameters ```powershell list-repos.ps1 [[-ParentDir] ] [] -ParentDir + Specifies the path to the parent folder. Required? false Position? 1 diff --git a/Docs/list-services.md b/Docs/list-services.md index 2879dde0..89384b53 100644 --- a/Docs/list-services.md +++ b/Docs/list-services.md @@ -1,6 +1,6 @@ ## list-services.ps1 - Lists the local computer services -list-services.ps1 +This script lists all local computer services. ## Parameters ```powershell diff --git a/Docs/list-sql-tables.md b/Docs/list-sql-tables.md index 6637491d..1a694edd 100644 --- a/Docs/list-sql-tables.md +++ b/Docs/list-sql-tables.md @@ -1,7 +1,6 @@ ## 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 Run the above command if you do not have this module. diff --git a/Docs/list-submodules.md b/Docs/list-submodules.md index d87b8ba6..24d56108 100644 --- a/Docs/list-submodules.md +++ b/Docs/list-submodules.md @@ -1,13 +1,13 @@ ## list-submodules.ps1 - Lists the submodules of a Git repository -list-submodules.ps1 [] - is the path to the repository (current working dir by default) +This script lists the submodules of the given Git repository. ## Parameters ```powershell list-submodules.ps1 [[-RepoDir] ] [] -RepoDir + Specifies the path to the repository (current working dir by default) Required? false Position? 1 diff --git a/Docs/list-tags.md b/Docs/list-tags.md index bb5ff507..c635498d 100644 --- a/Docs/list-tags.md +++ b/Docs/list-tags.md @@ -1,14 +1,13 @@ ## list-tags.ps1 - Lists all tags in a Git repository -list-tags.ps1 [] [] - is the path to the Git repository - is "*" (anything) by default +This script lists all tags in the given Git repository. ## Parameters ```powershell list-tags.ps1 [[-RepoDir] ] [[-SearchPattern] ] [] -RepoDir + Specifies the path to the Git repository Required? false Position? 1 @@ -17,6 +16,7 @@ list-tags.ps1 [[-RepoDir] ] [[-SearchPattern] ] [ + Specifies the search pattern (anything by default) Required? false Position? 2 diff --git a/Docs/list-tasks.md b/Docs/list-tasks.md index e6617c31..3d43eeed 100644 --- a/Docs/list-tasks.md +++ b/Docs/list-tasks.md @@ -1,6 +1,6 @@ ## list-tasks.ps1 - Lists all Windows scheduler tasks -list-tasks.ps1 +This script lists all Windows scheduler tasks. ## Parameters ```powershell diff --git a/Docs/say-operating-system.md b/Docs/say-operating-system.md new file mode 100644 index 00000000..6204cbb6 --- /dev/null +++ b/Docs/say-operating-system.md @@ -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 [] + +[] + 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* diff --git a/Docs/thank-you.md b/Docs/thank-you.md new file mode 100644 index 00000000..2ae5c085 --- /dev/null +++ b/Docs/thank-you.md @@ -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 [] + +[] + 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* diff --git a/Scripts/export-to-manuals.ps1 b/Scripts/export-to-manuals.ps1 index 416a1c15..ca371e69 100755 --- a/Scripts/export-to-manuals.ps1 +++ b/Scripts/export-to-manuals.ps1 @@ -21,7 +21,7 @@ try { $StopWatch = [system.diagnostics.stopwatch]::startNew() $Scripts = Get-ChildItem "$FilePattern" - "Found $($Scripts.Count) scripts, exporting to $TargetDir..." + "⏳ Exporting $($Scripts.Count) scripts to $TargetDir..." foreach ($Script in $Scripts) { & "$PSScriptRoot/convert-ps2md" "$Script" > "$TargetDir/$($Script.BaseName).md"