From 27bd3663941e963a9fc88b2db39aa2971218b175 Mon Sep 17 00:00:00 2001 From: Markus Fleschutz Date: Tue, 12 Oct 2021 21:51:51 +0200 Subject: [PATCH] Update the comment based help text --- Docs/add-firewall-rules.md | 5 +++-- Docs/add-memo.md | 5 +++-- Docs/alert.md | 5 +++-- Docs/build-repo.md | 4 ++-- Docs/build-repos.md | 2 +- Docs/cd-desktop.md | 4 ++-- Docs/cd-docs.md | 4 ++-- Docs/cd-downloads.md | 4 ++-- Docs/cd-dropbox.md | 4 ++-- Docs/cd-home.md | 4 ++-- Docs/cd-music.md | 4 ++-- Docs/cd-onedrive.md | 4 ++-- Docs/cd-pics.md | 4 ++-- Docs/cd-repos.md | 4 ++-- Docs/cd-root.md | 4 ++-- Docs/cd-scripts.md | 4 ++-- Docs/cd-ssh.md | 4 ++-- Docs/cd-up.md | 4 ++-- Docs/cd-up2.md | 4 ++-- Docs/cd-up3.md | 4 ++-- Docs/cd-up4.md | 4 ++-- Docs/cd-videos.md | 4 ++-- Docs/check-cpu-temp.md | 2 +- Docs/check-dns-resolution.md | 2 +- Docs/check-drive-space.md | 4 +++- Docs/export-to-manuals.md | 2 +- Scripts/add-firewall-rules.ps1 | 6 ++++-- Scripts/add-memo.ps1 | 6 ++++-- Scripts/alert.ps1 | 6 ++++-- Scripts/build-repo.ps1 | 4 ++-- Scripts/build-repos.ps1 | 2 +- Scripts/cd-desktop.ps1 | 4 ++-- Scripts/cd-docs.ps1 | 4 ++-- Scripts/cd-downloads.ps1 | 4 ++-- Scripts/cd-dropbox.ps1 | 4 ++-- Scripts/cd-home.ps1 | 4 ++-- Scripts/cd-music.ps1 | 4 ++-- Scripts/cd-onedrive.ps1 | 4 ++-- Scripts/cd-pics.ps1 | 4 ++-- Scripts/cd-recycle-bin.ps1 | 4 ++-- Scripts/cd-repos.ps1 | 4 ++-- Scripts/cd-root.ps1 | 4 ++-- Scripts/cd-scripts.ps1 | 4 ++-- Scripts/cd-ssh.ps1 | 4 ++-- Scripts/cd-up.ps1 | 4 ++-- Scripts/cd-up2.ps1 | 4 ++-- Scripts/cd-up3.ps1 | 4 ++-- Scripts/cd-up4.ps1 | 4 ++-- Scripts/cd-videos.ps1 | 4 ++-- Scripts/check-cpu-temp.ps1 | 2 +- Scripts/check-dns-resolution.ps1 | 2 +- Scripts/check-drive-space.ps1 | 6 +++++- Scripts/export-to-manuals.ps1 | 4 ++-- 53 files changed, 112 insertions(+), 97 deletions(-) diff --git a/Docs/add-firewall-rules.md b/Docs/add-firewall-rules.md index 9cd5a69c..f11b0eb7 100644 --- a/Docs/add-firewall-rules.md +++ b/Docs/add-firewall-rules.md @@ -1,12 +1,13 @@ -## add-firewall-rules.ps1 - Adds firewall rules for the given executables (needs admin rights) +## add-firewall-rules.ps1 - Adds firewall rules for executables (needs admin rights) -add-firewall-rules.ps1 [] +This script adds firewall rules for the given executable. Administrator rights are required. ## Parameters ```powershell add-firewall-rules.ps1 [[-PathToExecutables] ] [] -PathToExecutables + Specifies the path to the executables Required? false Position? 1 diff --git a/Docs/add-memo.md b/Docs/add-memo.md index 57679b46..f74942e2 100644 --- a/Docs/add-memo.md +++ b/Docs/add-memo.md @@ -1,12 +1,13 @@ -## add-memo.ps1 - Adds a memo to Memos.csv in the home folder +## add-memo.ps1 - Adds a memo text to $HOME/Memos.csv -add-memo.ps1 [] +This script adds the given memo text to $HOME/Memos.csv. ## Parameters ```powershell add-memo.ps1 [[-text] ] [] -text + Specifies the text to memorize Required? false Position? 1 diff --git a/Docs/alert.md b/Docs/alert.md index ded265ff..c238f900 100644 --- a/Docs/alert.md +++ b/Docs/alert.md @@ -1,12 +1,13 @@ -## alert.ps1 - Handle and escalate the given alert message +## alert.ps1 - Handles and escalates an alert -alert.ps1 [] +This script handles and escalates the given alert message. ## Parameters ```powershell alert.ps1 [[-Message] ] [] -Message + Specifies the alert message Required? false Position? 1 diff --git a/Docs/build-repo.md b/Docs/build-repo.md index 0dac2ac7..4cff37e6 100644 --- a/Docs/build-repo.md +++ b/Docs/build-repo.md @@ -1,13 +1,13 @@ ## build-repo.ps1 - Builds a Git repository -Supports building with cmake, configure, autogen, Imakefile and Makefile. +This scripts supports building with cmake, configure, autogen, Imakefile and Makefile. ## Parameters ```powershell build-repo.ps1 [[-RepoDir] ] [] -RepoDir - Specifies the path to the Git repository. + Specifies the path to the Git repository Required? false Position? 1 diff --git a/Docs/build-repos.md b/Docs/build-repos.md index 028db4e1..b6719d6b 100644 --- a/Docs/build-repos.md +++ b/Docs/build-repos.md @@ -1,6 +1,6 @@ ## build-repos.ps1 - Builds all Git repositories in a folder -build-repos.ps1 [] +This script builds all Git repositories in a given folder. ## Parameters ```powershell diff --git a/Docs/cd-desktop.md b/Docs/cd-desktop.md index 92728b87..844d60f4 100644 --- a/Docs/cd-desktop.md +++ b/Docs/cd-desktop.md @@ -1,6 +1,6 @@ -## cd-desktop.ps1 - Change the working directory to the user's desktop folder +## cd-desktop.ps1 - Sets the working directory to the user's desktop folder -cd-desktop.ps1 +This script changes the working directory to the user's desktop folder. ## Parameters ```powershell diff --git a/Docs/cd-docs.md b/Docs/cd-docs.md index aeb4a34f..6439a14b 100644 --- a/Docs/cd-docs.md +++ b/Docs/cd-docs.md @@ -1,6 +1,6 @@ -## cd-docs.ps1 - Change the working directory to the user's documents folder +## cd-docs.ps1 - Sets the working directory to the user's documents folder -cd-docs.ps1 +This scripts changes the working directory to the user's documents folder. ## Parameters ```powershell diff --git a/Docs/cd-downloads.md b/Docs/cd-downloads.md index 9dd4dee9..edf9346d 100644 --- a/Docs/cd-downloads.md +++ b/Docs/cd-downloads.md @@ -1,6 +1,6 @@ -## cd-downloads.ps1 - Change the working directory to the user's downloads folder +## cd-downloads.ps1 - Sets the working directory to the user's downloads folder -cd-downloads.ps1 +This script changes the working directory to the user's downloads folder. ## Parameters ```powershell diff --git a/Docs/cd-dropbox.md b/Docs/cd-dropbox.md index 352047b2..71b7d4c2 100644 --- a/Docs/cd-dropbox.md +++ b/Docs/cd-dropbox.md @@ -1,6 +1,6 @@ -## cd-dropbox.ps1 - Change the working directory to the user's Dropbox folder +## cd-dropbox.ps1 - Sets the working directory to the user's Dropbox folder -cd-dropbox.ps1 +This script changes the working directory to the user's Dropbox folder. ## Parameters ```powershell diff --git a/Docs/cd-home.md b/Docs/cd-home.md index 7652aab7..d4af8e06 100644 --- a/Docs/cd-home.md +++ b/Docs/cd-home.md @@ -1,6 +1,6 @@ -## cd-home.ps1 - Change the working directory to the user's home directory +## cd-home.ps1 - Sets the working directory to the user's home directory -cd-home.ps1 +This script changes the working directory to the user's home directory. ## Parameters ```powershell diff --git a/Docs/cd-music.md b/Docs/cd-music.md index f3da050f..cce99a33 100644 --- a/Docs/cd-music.md +++ b/Docs/cd-music.md @@ -1,6 +1,6 @@ -## cd-music.ps1 - Change the working directory to the user's music folder +## cd-music.ps1 - Sets the working directory to the user's music folder -cd-music.ps1 +This script changes the working directory to the user's music folder. ## Parameters ```powershell diff --git a/Docs/cd-onedrive.md b/Docs/cd-onedrive.md index f85f5056..aee34662 100644 --- a/Docs/cd-onedrive.md +++ b/Docs/cd-onedrive.md @@ -1,6 +1,6 @@ -## cd-onedrive.ps1 - Change the working directory to the user's OneDrive folder +## cd-onedrive.ps1 - Sets the working directory to the user's OneDrive folder -cd-onedrive.ps1 +This script changes the working directory to the user's OneDrive folder. ## Parameters ```powershell diff --git a/Docs/cd-pics.md b/Docs/cd-pics.md index da34a977..21dcbff6 100644 --- a/Docs/cd-pics.md +++ b/Docs/cd-pics.md @@ -1,6 +1,6 @@ -## cd-pics.ps1 - Change the working directory to the user's pictures folder +## cd-pics.ps1 - Sets the working directory to the user's pictures folder -cd-pics.ps1 +This script changes the working directory to the user's pictures folder. ## Parameters ```powershell diff --git a/Docs/cd-repos.md b/Docs/cd-repos.md index de30a87c..fb9e8273 100644 --- a/Docs/cd-repos.md +++ b/Docs/cd-repos.md @@ -1,6 +1,6 @@ -## cd-repos.ps1 - Change the working directory to the user's Git repositories folder +## cd-repos.ps1 - Sets the working directory to the user's Git repositories folder -cd-repos.ps1 +This script changes the working directory to the user's Git repositories folder. ## Parameters ```powershell diff --git a/Docs/cd-root.md b/Docs/cd-root.md index e135cc75..b09104e8 100644 --- a/Docs/cd-root.md +++ b/Docs/cd-root.md @@ -1,6 +1,6 @@ -## cd-root.ps1 - Change the working directory to the root directory (C:\ on Windows) +## cd-root.ps1 - Sets the working directory to the root directory (C:\ on Windows) -cd-root.ps1 +This script changes the working directory to the root directory (C:\ on Windows). ## Parameters ```powershell diff --git a/Docs/cd-scripts.md b/Docs/cd-scripts.md index 3d934200..64d5866d 100644 --- a/Docs/cd-scripts.md +++ b/Docs/cd-scripts.md @@ -1,6 +1,6 @@ -## cd-scripts.ps1 - Change the working directory to the PowerShell scripts folder +## cd-scripts.ps1 - Sets the working directory to the PowerShell scripts folder -cd-scripts.ps1 +This script changes the working directory to the PowerShell scripts folder. ## Parameters ```powershell diff --git a/Docs/cd-ssh.md b/Docs/cd-ssh.md index 7888aa11..0e1f4a14 100644 --- a/Docs/cd-ssh.md +++ b/Docs/cd-ssh.md @@ -1,6 +1,6 @@ -## cd-ssh.ps1 - Change the working directory to the user's SSH folder +## cd-ssh.ps1 - Sets the working directory to the user's SSH folder -cd-ssh.ps1 +This script changes the working directory to the user's SSH folder. ## Parameters ```powershell diff --git a/Docs/cd-up.md b/Docs/cd-up.md index 0099be6a..55434b27 100644 --- a/Docs/cd-up.md +++ b/Docs/cd-up.md @@ -1,6 +1,6 @@ -## cd-up.ps1 - Change the working directory to one level up +## cd-up.ps1 - Sets the working directory to one level up -cd-up.ps1 +This script changes the working directory to one directory level up. ## Parameters ```powershell diff --git a/Docs/cd-up2.md b/Docs/cd-up2.md index 5dce7bd0..52369bc1 100644 --- a/Docs/cd-up2.md +++ b/Docs/cd-up2.md @@ -1,6 +1,6 @@ -## cd-up2.ps1 - Change the working directory to two directory levels up +## cd-up2.ps1 - Sets the working directory to two directory levels up -cd-up2.ps1 +This script changes the working directory to two directory level up. ## Parameters ```powershell diff --git a/Docs/cd-up3.md b/Docs/cd-up3.md index 6fda6867..43bb886e 100644 --- a/Docs/cd-up3.md +++ b/Docs/cd-up3.md @@ -1,6 +1,6 @@ -## cd-up3.ps1 - Change the working directory to three directory levels up +## cd-up3.ps1 - Sets the working directory to three directory levels up -cd-up3.ps1 +This script changes the working directory to three directory levels up. ## Parameters ```powershell diff --git a/Docs/cd-up4.md b/Docs/cd-up4.md index 36264582..a91b35dc 100644 --- a/Docs/cd-up4.md +++ b/Docs/cd-up4.md @@ -1,6 +1,6 @@ -## cd-up4.ps1 - Change the working directory to four directory levels up +## cd-up4.ps1 - Sets the working directory to four directory levels up -cd-up4.ps1 +This script changes the working directory to four directory levels up. ## Parameters ```powershell diff --git a/Docs/cd-videos.md b/Docs/cd-videos.md index 4fac64e2..b3dbe322 100644 --- a/Docs/cd-videos.md +++ b/Docs/cd-videos.md @@ -1,6 +1,6 @@ -## cd-videos.ps1 - Change the working directory to the user's videos folder +## cd-videos.ps1 - Sets the working directory to the user's videos folder -cd-videos.ps1 +This script changes the working directory to the user's videos folder. ## Parameters ```powershell diff --git a/Docs/check-cpu-temp.md b/Docs/check-cpu-temp.md index f94a0bce..2c4ecbd5 100644 --- a/Docs/check-cpu-temp.md +++ b/Docs/check-cpu-temp.md @@ -1,6 +1,6 @@ ## check-cpu-temp.ps1 - Checks the CPU temperature -check-cpu-temp.ps1 +This script checks the CPU temperature. ## Parameters ```powershell diff --git a/Docs/check-dns-resolution.md b/Docs/check-dns-resolution.md index 44a58401..782ae65d 100644 --- a/Docs/check-dns-resolution.md +++ b/Docs/check-dns-resolution.md @@ -1,6 +1,6 @@ ## check-dns-resolution.ps1 - Checks the DNS resolution with frequently used domain names -check-dns-resolution.ps1 +This script checks the DNS resolution with frequently used domain names. ## Parameters ```powershell diff --git a/Docs/check-drive-space.md b/Docs/check-drive-space.md index 0bc84374..b559419c 100644 --- a/Docs/check-drive-space.md +++ b/Docs/check-drive-space.md @@ -1,12 +1,13 @@ ## check-drive-space.ps1 - Checks a drive for free space left (20 GB by default) -check-drive-space.ps1 [] [] +This script checks a drive for free space left (20 GB by default). ## Parameters ```powershell check-drive-space.ps1 [[-Drive] ] [[-MinLevel] ] [] -Drive + Specifies the drive to check Required? false Position? 1 @@ -15,6 +16,7 @@ check-drive-space.ps1 [[-Drive] ] [[-MinLevel] ] [ + Specifies the minimum level in Gigabyte Required? false Position? 2 diff --git a/Docs/export-to-manuals.md b/Docs/export-to-manuals.md index 92235a8d..947a03a5 100644 --- a/Docs/export-to-manuals.md +++ b/Docs/export-to-manuals.md @@ -30,7 +30,7 @@ export-to-manuals.ps1 [[-FilePattern] ] [[-TargetDir] ] [./export-to-manuals.ps1 -Found 264 scripts, starting export to /home/markus/PowerShell/Docs... +Found 264 scripts, exporting to /home/markus/PowerShell/Docs... ✔️ exported 264 scripts as manuals in 28 sec ``` diff --git a/Scripts/add-firewall-rules.ps1 b/Scripts/add-firewall-rules.ps1 index 2ee7a14f..bd86d762 100755 --- a/Scripts/add-firewall-rules.ps1 +++ b/Scripts/add-firewall-rules.ps1 @@ -1,8 +1,10 @@ <# .SYNOPSIS - Adds firewall rules for the given executables (needs admin rights) + Adds firewall rules for executables (needs admin rights) .DESCRIPTION - add-firewall-rules.ps1 [] + This script adds firewall rules for the given executable. Administrator rights are required. +.PARAMETER PathToExecutables + Specifies the path to the executables .EXAMPLE PS> ./add-firewall-rules C:\MyApp\bin Adding firewall rule for C:\MyApp\bin\app1.exe diff --git a/Scripts/add-memo.ps1 b/Scripts/add-memo.ps1 index d7ef1d57..3ef79d1e 100755 --- a/Scripts/add-memo.ps1 +++ b/Scripts/add-memo.ps1 @@ -1,8 +1,10 @@ <# .SYNOPSIS - Adds a memo to Memos.csv in the home folder + Adds a memo text to $HOME/Memos.csv .DESCRIPTION - add-memo.ps1 [] + This script adds the given memo text to $HOME/Memos.csv. +.PARAMETER text + Specifies the text to memorize .EXAMPLE PS> ./add-memo "Buy apples" ✔️ added to 📄/home/markus/Memos.csv diff --git a/Scripts/alert.ps1 b/Scripts/alert.ps1 index 89ff5354..1ab371f9 100755 --- a/Scripts/alert.ps1 +++ b/Scripts/alert.ps1 @@ -1,8 +1,10 @@ <# .SYNOPSIS - Handle and escalate the given alert message + Handles and escalates an alert .DESCRIPTION - alert.ps1 [] + This script handles and escalates the given alert message. +.PARAMETER message + Specifies the alert message .EXAMPLE PS> ./alert "Harddisk failure" .LINK diff --git a/Scripts/build-repo.ps1 b/Scripts/build-repo.ps1 index 5f475df1..2bbd1f9a 100755 --- a/Scripts/build-repo.ps1 +++ b/Scripts/build-repo.ps1 @@ -2,9 +2,9 @@ .SYNOPSIS Builds a Git repository .DESCRIPTION - Supports building with cmake, configure, autogen, Imakefile and Makefile. + This scripts supports building with cmake, configure, autogen, Imakefile and Makefile. .PARAMETER RepoDir - Specifies the path to the Git repository. + Specifies the path to the Git repository .EXAMPLE PS> ./build-repo C:\MyRepo .NOTES diff --git a/Scripts/build-repos.ps1 b/Scripts/build-repos.ps1 index d09d7b17..8b99ea7c 100755 --- a/Scripts/build-repos.ps1 +++ b/Scripts/build-repos.ps1 @@ -2,7 +2,7 @@ .SYNOPSIS Builds all Git repositories in a folder .DESCRIPTION - build-repos.ps1 [] + This script builds all Git repositories in a given folder. .PARAMETER ParentDir Specifies the path to the folder containing the Git repositories .EXAMPLE diff --git a/Scripts/cd-desktop.ps1 b/Scripts/cd-desktop.ps1 index cb9d0042..53fbaa65 100755 --- a/Scripts/cd-desktop.ps1 +++ b/Scripts/cd-desktop.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's desktop folder + Sets the working directory to the user's desktop folder .DESCRIPTION - cd-desktop.ps1 + This script changes the working directory to the user's desktop folder. .EXAMPLE PS> ./cd-desktop 📂/home/markus/Desktop diff --git a/Scripts/cd-docs.ps1 b/Scripts/cd-docs.ps1 index 3255f047..f05c31fe 100755 --- a/Scripts/cd-docs.ps1 +++ b/Scripts/cd-docs.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's documents folder + Sets the working directory to the user's documents folder .DESCRIPTION - cd-docs.ps1 + This scripts changes the working directory to the user's documents folder. .EXAMPLE PS> ./cd-docs 📂/home/markus/Documents diff --git a/Scripts/cd-downloads.ps1 b/Scripts/cd-downloads.ps1 index 0edd5804..05606c71 100755 --- a/Scripts/cd-downloads.ps1 +++ b/Scripts/cd-downloads.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's downloads folder + Sets the working directory to the user's downloads folder .DESCRIPTION - cd-downloads.ps1 + This script changes the working directory to the user's downloads folder. .EXAMPLE PS> ./cd-downloads 📂/home/markus/Downloads diff --git a/Scripts/cd-dropbox.ps1 b/Scripts/cd-dropbox.ps1 index 0de07981..052db781 100755 --- a/Scripts/cd-dropbox.ps1 +++ b/Scripts/cd-dropbox.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's Dropbox folder + Sets the working directory to the user's Dropbox folder .DESCRIPTION - cd-dropbox.ps1 + This script changes the working directory to the user's Dropbox folder. .EXAMPLE PS> ./cd-dropbox 📂/home/markus/Dropbox diff --git a/Scripts/cd-home.ps1 b/Scripts/cd-home.ps1 index c731825a..89dec9a6 100755 --- a/Scripts/cd-home.ps1 +++ b/Scripts/cd-home.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's home directory + Sets the working directory to the user's home directory .DESCRIPTION - cd-home.ps1 + This script changes the working directory to the user's home directory. .EXAMPLE PS> ./cd-home 📂/home/markus diff --git a/Scripts/cd-music.ps1 b/Scripts/cd-music.ps1 index 9159ecf4..f429fbbc 100755 --- a/Scripts/cd-music.ps1 +++ b/Scripts/cd-music.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's music folder + Sets the working directory to the user's music folder .DESCRIPTION - cd-music.ps1 + This script changes the working directory to the user's music folder. .EXAMPLE PS> ./cd-music 📂/home/markus/Music diff --git a/Scripts/cd-onedrive.ps1 b/Scripts/cd-onedrive.ps1 index dd161108..c20c8ba1 100644 --- a/Scripts/cd-onedrive.ps1 +++ b/Scripts/cd-onedrive.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's OneDrive folder + Sets the working directory to the user's OneDrive folder .DESCRIPTION - cd-onedrive.ps1 + This script changes the working directory to the user's OneDrive folder. .EXAMPLE PS> ./cd-onedrive 📂/home/markus/OneDrive diff --git a/Scripts/cd-pics.ps1 b/Scripts/cd-pics.ps1 index 89f8f2a4..6f7ddfdb 100755 --- a/Scripts/cd-pics.ps1 +++ b/Scripts/cd-pics.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's pictures folder + Sets the working directory to the user's pictures folder .DESCRIPTION - cd-pics.ps1 + This script changes the working directory to the user's pictures folder. .EXAMPLE PS> ./cd-pics 📂/home/markus/Pictures diff --git a/Scripts/cd-recycle-bin.ps1 b/Scripts/cd-recycle-bin.ps1 index 58d459f9..c491809b 100644 --- a/Scripts/cd-recycle-bin.ps1 +++ b/Scripts/cd-recycle-bin.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's recycle bin folder + Sets the working directory to the user's recycle bin folder .DESCRIPTION - cd-recycle-bin.ps1 + This script changes the working directory to the user's recycle bin folder. .EXAMPLE PS> ./cd-recycle-bin 📂C:\$Recycle.Bin\S-1-5-21-123404-23309-294260-1001 diff --git a/Scripts/cd-repos.ps1 b/Scripts/cd-repos.ps1 index 0270a8c4..ccba6bc7 100644 --- a/Scripts/cd-repos.ps1 +++ b/Scripts/cd-repos.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's Git repositories folder + Sets the working directory to the user's Git repositories folder .DESCRIPTION - cd-repos.ps1 + This script changes the working directory to the user's Git repositories folder. .EXAMPLE PS> ./cd-repos 📂/home/markus/Repos diff --git a/Scripts/cd-root.ps1 b/Scripts/cd-root.ps1 index 2b96aa68..a570ffda 100755 --- a/Scripts/cd-root.ps1 +++ b/Scripts/cd-root.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the root directory (C:\ on Windows) + Sets the working directory to the root directory (C:\ on Windows) .DESCRIPTION - cd-root.ps1 + This script changes the working directory to the root directory (C:\ on Windows). .EXAMPLE PS> ./cd-root 📂C:\ diff --git a/Scripts/cd-scripts.ps1 b/Scripts/cd-scripts.ps1 index 57db5149..6f1dd321 100755 --- a/Scripts/cd-scripts.ps1 +++ b/Scripts/cd-scripts.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the PowerShell scripts folder + Sets the working directory to the PowerShell scripts folder .DESCRIPTION - cd-scripts.ps1 + This script changes the working directory to the PowerShell scripts folder. .EXAMPLE PS> ./cd-scripts 📂/home/markus/PowerShell/Scripts diff --git a/Scripts/cd-ssh.ps1 b/Scripts/cd-ssh.ps1 index 61cac91f..db0c40d9 100755 --- a/Scripts/cd-ssh.ps1 +++ b/Scripts/cd-ssh.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's SSH folder + Sets the working directory to the user's SSH folder .DESCRIPTION - cd-ssh.ps1 + This script changes the working directory to the user's SSH folder. .EXAMPLE PS> ./cd-ssh 📂/home/markus/.ssh diff --git a/Scripts/cd-up.ps1 b/Scripts/cd-up.ps1 index 700839b9..9a7acd4b 100755 --- a/Scripts/cd-up.ps1 +++ b/Scripts/cd-up.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to one level up + Sets the working directory to one level up .DESCRIPTION - cd-up.ps1 + This script changes the working directory to one directory level up. .EXAMPLE PS> .\cd-up (one level up) diff --git a/Scripts/cd-up2.ps1 b/Scripts/cd-up2.ps1 index 0bb8c4ee..1308e25d 100644 --- a/Scripts/cd-up2.ps1 +++ b/Scripts/cd-up2.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to two directory levels up + Sets the working directory to two directory levels up .DESCRIPTION - cd-up2.ps1 + This script changes the working directory to two directory level up. .EXAMPLE PS> ./cd-up2 (two levels up) diff --git a/Scripts/cd-up3.ps1 b/Scripts/cd-up3.ps1 index 4722af88..394acb16 100644 --- a/Scripts/cd-up3.ps1 +++ b/Scripts/cd-up3.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to three directory levels up + Sets the working directory to three directory levels up .DESCRIPTION - cd-up3.ps1 + This script changes the working directory to three directory levels up. .EXAMPLE PS> ./cd-up3 (three levels up) diff --git a/Scripts/cd-up4.ps1 b/Scripts/cd-up4.ps1 index c866cf97..d5d01582 100644 --- a/Scripts/cd-up4.ps1 +++ b/Scripts/cd-up4.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to four directory levels up + Sets the working directory to four directory levels up .DESCRIPTION - cd-up4.ps1 + This script changes the working directory to four directory levels up. .EXAMPLE PS> ./cd-up4 (four levels up) diff --git a/Scripts/cd-videos.ps1 b/Scripts/cd-videos.ps1 index e2611fae..1ee54422 100755 --- a/Scripts/cd-videos.ps1 +++ b/Scripts/cd-videos.ps1 @@ -1,8 +1,8 @@ <# .SYNOPSIS - Change the working directory to the user's videos folder + Sets the working directory to the user's videos folder .DESCRIPTION - cd-videos.ps1 + This script changes the working directory to the user's videos folder. .EXAMPLE PS> ./cd-videos 📂/home/markus/Videos diff --git a/Scripts/check-cpu-temp.ps1 b/Scripts/check-cpu-temp.ps1 index df1fbf56..083c83ca 100755 --- a/Scripts/check-cpu-temp.ps1 +++ b/Scripts/check-cpu-temp.ps1 @@ -2,7 +2,7 @@ .SYNOPSIS Checks the CPU temperature .DESCRIPTION - check-cpu-temp.ps1 + This script checks the CPU temperature. .EXAMPLE PS> ./check-cpu-temp ✔️ 30.3 °C CPU temperature - good diff --git a/Scripts/check-dns-resolution.ps1 b/Scripts/check-dns-resolution.ps1 index 2197a248..e3cd48b6 100755 --- a/Scripts/check-dns-resolution.ps1 +++ b/Scripts/check-dns-resolution.ps1 @@ -2,7 +2,7 @@ .SYNOPSIS Checks the DNS resolution with frequently used domain names .DESCRIPTION - check-dns-resolution.ps1 + This script checks the DNS resolution with frequently used domain names. .EXAMPLE PS> ./check-dns-resolution ✔️ 11.8 domains/sec (177 domains resolved in 15 sec) diff --git a/Scripts/check-drive-space.ps1 b/Scripts/check-drive-space.ps1 index 175c65cd..450a8780 100755 --- a/Scripts/check-drive-space.ps1 +++ b/Scripts/check-drive-space.ps1 @@ -2,7 +2,11 @@ .SYNOPSIS Checks a drive for free space left (20 GB by default) .DESCRIPTION - check-drive-space.ps1 [] [] + This script checks a drive for free space left (20 GB by default). +.PARAMETER Drive + Specifies the drive to check +.PARAMETER MinLevel + Specifies the minimum level in Gigabyte .EXAMPLE PS> ./check-drive-space C ✔️ 172 GB left on drive C (61 of 233 GB used) diff --git a/Scripts/export-to-manuals.ps1 b/Scripts/export-to-manuals.ps1 index 11adeb75..416a1c15 100755 --- a/Scripts/export-to-manuals.ps1 +++ b/Scripts/export-to-manuals.ps1 @@ -5,7 +5,7 @@ This script exports the comment based help of all PowerShell scripts as manuals. .EXAMPLE PS> ./export-to-manuals.ps1 - Found 264 scripts, starting export to /home/markus/PowerShell/Docs... + Found 264 scripts, exporting to /home/markus/PowerShell/Docs... ✔️ exported 264 scripts as manuals in 28 sec .NOTES Author: Markus Fleschutz · License: CC0 @@ -21,7 +21,7 @@ try { $StopWatch = [system.diagnostics.stopwatch]::startNew() $Scripts = Get-ChildItem "$FilePattern" - "Found $($Scripts.Count) scripts, starting export to $TargetDir..." + "Found $($Scripts.Count) scripts, exporting to $TargetDir..." foreach ($Script in $Scripts) { & "$PSScriptRoot/convert-ps2md" "$Script" > "$TargetDir/$($Script.BaseName).md"