mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-08 20:54:38 +02:00
Update the comment based help text
This commit is contained in:
@ -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 [<PathToExecutables>]
|
||||
This script adds firewall rules for the given executable. Administrator rights are required.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
add-firewall-rules.ps1 [[-PathToExecutables] <String>] [<CommonParameters>]
|
||||
|
||||
-PathToExecutables <String>
|
||||
Specifies the path to the executables
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
|
@ -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 [<text>]
|
||||
This script adds the given memo text to $HOME/Memos.csv.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
add-memo.ps1 [[-text] <String>] [<CommonParameters>]
|
||||
|
||||
-text <String>
|
||||
Specifies the text to memorize
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
|
@ -1,12 +1,13 @@
|
||||
## alert.ps1 - Handle and escalate the given alert message
|
||||
## alert.ps1 - Handles and escalates an alert
|
||||
|
||||
alert.ps1 [<message>]
|
||||
This script handles and escalates the given alert message.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
alert.ps1 [[-Message] <String>] [<CommonParameters>]
|
||||
|
||||
-Message <String>
|
||||
Specifies the alert message
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
|
@ -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] <String>] [<CommonParameters>]
|
||||
|
||||
-RepoDir <String>
|
||||
Specifies the path to the Git repository.
|
||||
Specifies the path to the Git repository
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
|
@ -1,6 +1,6 @@
|
||||
## build-repos.ps1 - Builds all Git repositories in a folder
|
||||
|
||||
build-repos.ps1 [<ParentDir>]
|
||||
This script builds all Git repositories in a given folder.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -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
|
||||
|
@ -1,6 +1,6 @@
|
||||
## check-cpu-temp.ps1 - Checks the CPU temperature
|
||||
|
||||
check-cpu-temp.ps1
|
||||
This script checks the CPU temperature.
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
|
@ -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
|
||||
|
@ -1,12 +1,13 @@
|
||||
## check-drive-space.ps1 - Checks a drive for free space left (20 GB by default)
|
||||
|
||||
check-drive-space.ps1 [<drive>] [<min-level>]
|
||||
This script checks a drive for free space left (20 GB by default).
|
||||
|
||||
## Parameters
|
||||
```powershell
|
||||
check-drive-space.ps1 [[-Drive] <String>] [[-MinLevel] <Int32>] [<CommonParameters>]
|
||||
|
||||
-Drive <String>
|
||||
Specifies the drive to check
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
@ -15,6 +16,7 @@ check-drive-space.ps1 [[-Drive] <String>] [[-MinLevel] <Int32>] [<CommonParamete
|
||||
Accept wildcard characters? false
|
||||
|
||||
-MinLevel <Int32>
|
||||
Specifies the minimum level in Gigabyte
|
||||
|
||||
Required? false
|
||||
Position? 2
|
||||
|
@ -30,7 +30,7 @@ export-to-manuals.ps1 [[-FilePattern] <String>] [[-TargetDir] <String>] [<Common
|
||||
## Example
|
||||
```powershell
|
||||
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
|
||||
```
|
||||
|
||||
|
Reference in New Issue
Block a user