Update the comment based help

This commit is contained in:
Markus Fleschutz 2021-10-16 16:50:10 +02:00
parent c296024b8f
commit 73037be877
305 changed files with 820 additions and 474 deletions

View File

@ -1,12 +1,13 @@
## check-file-system.ps1 - Checks the file system of a drive (needs admin rights)
check-file-system.ps1 [<drive>]
This script checks the file system of a drive. It needs admin rights.
## Parameters
```powershell
check-file-system.ps1 [[-Drive] <String>] [<CommonParameters>]
-Drive <String>
Specifies the drive to check
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## check-health.ps1 - Checks the health of the local computer
check-health.ps1
This script checks the health of the local computer.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## check-ipv4-address.ps1 - Checks the given IPv4 address for validity
## check-ipv4-address.ps1 - Checks an IPv4 address for validity
check-ipv4-address.ps1 [<Address>]
This script checks the given IPv4 address for validity.
## Parameters
```powershell
check-ipv4-address.ps1 [[-Address] <String>] [<CommonParameters>]
-Address <String>
Specifies the IPv4 address to check
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## check-ipv6-address.ps1 - Checks the given IPv6 address for validity
## check-ipv6-address.ps1 - Checks an IPv6 address for validity
check-ipv6-address.ps1 [<Address>]
This script checks the given IPv6 address for validity
## Parameters
```powershell
check-ipv6-address.ps1 [[-Address] <String>] [<CommonParameters>]
-Address <String>
Specifies the IPv6 address to check
Required? false
Position? 1

View File

@ -1,13 +1,14 @@
## check-mac-address.ps1 - Checks the given MAC address for validity
This script checks the given MAC address for validity
Supported MAC address formats are: 00:00:00:00:00:00 or 00-00-00-00-00-00 or 000000000000.
check-mac-address.ps1 [<MAC>]
## Parameters
```powershell
check-mac-address.ps1 [[-MAC] <String>] [<CommonParameters>]
-MAC <String>
Specifies the MAC address to check
Required? false
Position? 1

View File

@ -1,13 +1,14 @@
## check-ping.ps1 - Checks the ping latency from the local computer to selected Internet hosts
Hosts by default are: amazon.com,apple.com,bing.com,cnn.com,dropbox.com,facebook.com,google.com,live.com,twitter.com,youtube.com
check-ping.ps1 [<hosts>]
This script checks the ping latency from the local computer to selected Internet hosts.
The hosts by default are: amazon.com,apple.com,bing.com,cnn.com,dropbox.com,facebook.com,google.com,live.com,twitter.com,youtube.com
## Parameters
```powershell
check-ping.ps1 [[-hosts] <String>] [<CommonParameters>]
-hosts <String>
Specifies the hosts to check (separated by comma)
Required? false
Position? 1

View File

@ -1,14 +1,14 @@
## check-smart-devices.ps1 - Performs a selftest on your S.M.A.R.T. HDD/SSD devices.
check-smart-devices.ps1 [<type>]
Type is either short(default) or long.
Requires smartctl (smartmontools package) and admin rights.
This script performs a selftest on your S.M.A.R.T. HDD/SSD devices.
It requires smartctl (smartmontools package) and admin rights.
## Parameters
```powershell
check-smart-devices.ps1 [[-type] <String>] [<CommonParameters>]
-type <String>
Specifies the type of selftest: either short (default) or long
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## check-subnet-mask.ps1 - Checks the given subnet mask for validity
check-subnet-mask.ps1 [<address>]
This script checks the given subnet mask for validity.
## Parameters
```powershell
check-subnet-mask.ps1 [[-address] <String>] [<CommonParameters>]
-address <String>
Specifies the subnet mask to check
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## check-swap-space.ps1 - Checks the free swap space
check-swap-space.ps1 [<min-level>]
This script checks the free swap space.
## Parameters
```powershell
check-swap-space.ps1 [[-MinLevel] <Int32>] [<CommonParameters>]
-MinLevel <Int32>
Specifies the minimum level (50 GB by default)
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## check-symlinks.ps1 - Checks every symlink in a folder (including subfolders)
check-symlinks.ps1 [<folder>]
This script checks every symlink in a folder (including subfolders).
Returns the number of broken symlinks as exit value.
## Parameters
@ -8,6 +8,7 @@ Returns the number of broken symlinks as exit value.
check-symlinks.ps1 [[-folder] <String>] [<CommonParameters>]
-folder <String>
Specifies the path to the directory tree
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## check-weather.ps1 - Checks the weather for critical values
check-weather.ps1 [<location>]
Checks the current weather for critical values.
## Parameters
```powershell
check-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 @@
## check-windows-system-files.ps1 - Checks the validity of the Windows system files (requires admin rights)
check-windows-system-files.ps1
This script checks the validity of the Windows system files. It requires admin rights.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## check-xml-file.ps1 - Checks the given XML file for validity
check-xml-file [<file>]
This script checks the given XML file for validity.
## Parameters
```powershell
check-xml-file.ps1 [[-file] <String>] [<CommonParameters>]
-file <String>
Specifies the path to the XML file to check
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## clean-repo.ps1 - Cleans a Git repository from untracked files (including submodules)
clean-repo.ps1 [<RepoDir>]
This script cleans a Git repository from untracked files (including submodules).
## Parameters
```powershell
clean-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
-RepoDir <String>
Specifies the path to the Git repository
Required? false
Position? 1
@ -22,7 +23,7 @@ clean-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
## Example
```powershell
PS>./clean-repo C:\MyRepo
🧹 Cleaning Git repository 📂C:\MyRepo from untracked files...
🧹 Cleaning from untracked files...
✔️ cleaned Git repository 📂C:\MyRepo in 0 sec
```

View File

@ -1,12 +1,13 @@
## clean-repos.ps1 - Cleans all Git repositories in a folder from untracked files (including submodules)
clean-repos.ps1 [<ParentDir>]
This script cleans all Git repositories in a folder from untracked files (including submodules).
## Parameters
```powershell
clean-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
-ParentDir <String>
Specifies the path to the parent folder
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## clear-recycle-bin.ps1 - Removes the content of the recycle bin folder permanently
clear-recycle-bin.ps1
This script removes the content of the recycle bin folder permanently.
NOTE: can not be undo!
## Parameters

View File

@ -1,12 +1,13 @@
## clone-repos.ps1 - Clones well-known Git repositories into a folder
clone-repos.ps1 [<folder>]
This script clones well-known Git repositories into a folder.
## Parameters
```powershell
clone-repos.ps1 [[-folder] <String>] [<CommonParameters>]
-folder <String>
Specifies the target folder
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## close-calculator.ps1 - Closes the calculator program gracefully
## close-calculator.ps1 - Closes the calculator program
close-calculator.ps1
This script closes the calculator program gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-chrome.ps1 - Closes the Google Chrome Web browser
close-chrome.ps1
This script closes the Google Chrome Web browser gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-cortana.ps1 - Closes Microsoft's Cortana application
close-cortana.ps1
This script closes Microsoft's Cortana application gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-edge.ps1 - Closes Microsoft's Edge Web browser
close-edge.ps1
This script closes Microsoft's Edge Web browser gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-file-explorer.ps1 - Closes Microsoft's File Explorer
close-file-explorer.ps1
This script closes Microsoft's File Explorer gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-firefox.ps1 - Closes Mozilla's Firefox Web browser
close-firefox.ps1
This script closes Mozilla's Firefox Web browser gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-netflix.ps1 - Closes the Netflix application
close-netflix.ps1
This script closes the Netflix application gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-onedrive.ps1 - Closes Microsoft's OneDrive folder
close-onedrive.ps1
This script closes Microsoft's OneDrive folder gracefully.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## close-program.ps1 - Closes the processes of the given program gracefully
## close-program.ps1 - Closes a program's processes
close-program.ps1 [<FullProgramName>] [<ProgramName>] [<ProgramAliasName>]
This script closes a program's processes gracefully.
## Parameters
```powershell
close-program.ps1 [[-FullProgramName] <String>] [[-ProgramName] <String>] [[-ProgramAliasName] <String>] [<CommonParameters>]
-FullProgramName <String>
Specifies the full program name
Required? false
Position? 1
@ -15,6 +16,7 @@ close-program.ps1 [[-FullProgramName] <String>] [[-ProgramName] <String>] [[-Pro
Accept wildcard characters? false
-ProgramName <String>
Specifies the program name
Required? false
Position? 2
@ -23,6 +25,7 @@ close-program.ps1 [[-FullProgramName] <String>] [[-ProgramName] <String>] [[-Pro
Accept wildcard characters? false
-ProgramAliasName <String>
Specifies the program alias name
Required? false
Position? 3

View File

@ -1,6 +1,6 @@
## close-system-settings.ps1 - Closes the System Settings window
close-system-settings.ps1
This script closes the System Settings window gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-thunderbird.ps1 - Closes Mozilla's Thunderbird email client
close-thunderbird.ps1
This script closes Mozilla's Thunderbird email client gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-vlc.ps1 - Closes the VLC media player application
close-vlc.ps1
This script closes the VLC media player application gracefully.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## close-windows-terminal.ps1 - Closes the Windows Terminal application
close-windows-terminal.ps1
This script closes the Windows Terminal application gracefully.
## Parameters
```powershell
@ -14,6 +14,7 @@ close-windows-terminal.ps1 [<CommonParameters>]
## Example
```powershell
PS>./close-windows-terminal
(Windows Terminal is closed)
```
## Notes

View File

@ -1,12 +1,13 @@
## configure-git.ps1 - Configures the user settings for Git
configure-git.ps1 [<full-name>] [<email-address>] [<favorite-editor>]
This script configures the user settings for Git.
## Parameters
```powershell
configure-git.ps1 [[-FullName] <String>] [[-EmailAddress] <String>] [[-FavoriteEditor] <String>] [<CommonParameters>]
-FullName <String>
Specifies the user's full name
Required? false
Position? 1
@ -15,6 +16,7 @@ configure-git.ps1 [[-FullName] <String>] [[-EmailAddress] <String>] [[-FavoriteE
Accept wildcard characters? false
-EmailAddress <String>
Specifies the user's email address
Required? false
Position? 2
@ -23,6 +25,7 @@ configure-git.ps1 [[-FullName] <String>] [[-EmailAddress] <String>] [[-FavoriteE
Accept wildcard characters? false
-FavoriteEditor <String>
Specifies the user's favorite text editor
Required? false
Position? 3

View File

@ -1,12 +1,13 @@
## convert-csv2txt.ps1 - Converts a .CSV file into a text file
convert-csv2txt.ps1 [<csv-file>]
This script converts a .CSV file into a text file.
## Parameters
```powershell
convert-csv2txt.ps1 [[-Path] <String>] [<CommonParameters>]
-Path <String>
Specifies the path to the .CSV file
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## convert-mysql2csv.ps1 - Convert a MySQL database table to a .CSV file
convert-mysql2csv.ps1 [<server>] [<database>] [<username>] [<password>] [<query>]
This script converts a MySQL database table to a .CSV file.
## Parameters
```powershell
convert-mysql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <String>] [[-password] <String>] [[-query] <String>] [<CommonParameters>]
-server <String>
Specifies the server's hostname or IP address
Required? false
Position? 1
@ -15,6 +16,7 @@ convert-mysql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <
Accept wildcard characters? false
-database <String>
Specifies the database name
Required? false
Position? 2
@ -23,6 +25,7 @@ convert-mysql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <
Accept wildcard characters? false
-username <String>
Specifies the user name
Required? false
Position? 3
@ -31,6 +34,7 @@ convert-mysql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <
Accept wildcard characters? false
-password <String>
Specifies the password
Required? false
Position? 4
@ -39,6 +43,7 @@ convert-mysql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <
Accept wildcard characters? false
-query <String>
Specifies the SQL query
Required? false
Position? 5

View File

@ -1,12 +1,13 @@
## convert-ps2bat.ps1 - Converts a PowerShell script to .bat files
## convert-ps2bat.ps1 - Converts PowerShell scripts to batch files
convert-ps2bat.ps1 [<pattern>]
This script converts one or more PowerShell scripts to .bat batch files.
## Parameters
```powershell
convert-ps2bat.ps1 [[-Pattern] <String>] [<CommonParameters>]
convert-ps2bat.ps1 [[-Filepattern] <String>] [<CommonParameters>]
-Pattern <String>
-Filepattern <String>
Specifies the file pattern
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## convert-ps2md.ps1 - Converts the comment-based help of a PowerShell script to Markdown
convert-ps2md.ps1 [<filename>]
This script converts the comment-based help of a PowerShell script to Markdown.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## convert-sql2csv.ps1 - Converts a SQL database table to a .CSV file
convert-sql2csv.ps1 [<server>] [<database>] [<username>] [<password>] [<query>]
This script converts a SQL database table to a .CSV file.
## Parameters
```powershell
convert-sql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <String>] [[-password] <String>] [[-query] <String>] [<CommonParameters>]
-server <String>
Specifies the server's hostname or IP address
Required? false
Position? 1
@ -15,6 +16,7 @@ convert-sql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <St
Accept wildcard characters? false
-database <String>
Specifies the database name
Required? false
Position? 2
@ -23,6 +25,7 @@ convert-sql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <St
Accept wildcard characters? false
-username <String>
Specifies the user name
Required? false
Position? 3
@ -31,6 +34,7 @@ convert-sql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <St
Accept wildcard characters? false
-password <String>
Specifies the password
Required? false
Position? 4
@ -39,6 +43,7 @@ convert-sql2csv.ps1 [[-server] <String>] [[-database] <String>] [[-username] <St
Accept wildcard characters? false
-query <String>
Specifies the SQL query
Required? false
Position? 5

View File

@ -1,12 +1,13 @@
## convert-txt2wav.ps1 - Converts text to a .WAV audio file
convert-txt2wav.ps1 [<text>] [<wav-file>]
This script converts text to a .WAV audio file.
## Parameters
```powershell
convert-txt2wav.ps1 [[-Text] <String>] [[-WavFile] <String>] [<CommonParameters>]
-Text <String>
Specifies the text to use
Required? false
Position? 1
@ -15,6 +16,7 @@ convert-txt2wav.ps1 [[-Text] <String>] [[-WavFile] <String>] [<CommonParameters>
Accept wildcard characters? false
-WavFile <String>
Specifies the path to the resulting WAV file
Required? false
Position? 2

View File

@ -1,42 +1,13 @@
## copy-photos-sorted.ps1 - Copy image files sorted by year and month
## copy-photos-sorted.ps1 - copy-photos-sorted.ps1 [[-SourceDir] <string>] [[-TargetDir] <string>]
Copy image files from SourceDir to TargetDir sorted by year and month
copy-photos-sorted.ps1 [<SourceDir>] [<TargetDir>]
## Parameters
```powershell
copy-photos-sorted.ps1 [[-SourceDir] <String>] [[-TargetDir] <String>] [<CommonParameters>]
-SourceDir <String>
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-TargetDir <String>
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS>./copy-photos-sorted D:\Mobile\DCIM C:\MyPhotoAlbum
```
## Notes
Author: Markus Fleschutz · License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of copy-photos-sorted.ps1*

View File

@ -1,12 +1,13 @@
## decrypt-file.ps1 - Decrypts the given file
decrypt-file.ps1 [<path>] [<password>]
This script decrypts the given file.
## Parameters
```powershell
decrypt-file.ps1 [[-Path] <String>] [[-Password] <String>] [<CommonParameters>]
-Path <String>
Specifies the path to the file to decrypt
Required? false
Position? 1
@ -15,6 +16,7 @@ decrypt-file.ps1 [[-Path] <String>] [[-Password] <String>] [<CommonParameters>]
Accept wildcard characters? false
-Password <String>
Specifies the password
Required? false
Position? 2

View File

@ -1,13 +1,13 @@
## display-time.ps1 - Displays the current time
Displays the current time (for 10 seconds by default)
display-time.ps1 [<seconds>]
## Parameters
```powershell
display-time.ps1 [[-Seconds] <Int32>] [<CommonParameters>]
-Seconds <Int32>
Specifies the number of seconds to display the time
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## download-dir.ps1 - Downloads a folder (including subfolders) from the given URL
## download-dir.ps1 - Downloads a folder (including subfolders) from an URL
download-dir.ps1 [<URL>]
This script downloads a folder (including subfolders) from the given URL.
## Parameters
```powershell
download-dir.ps1 [[-URL] <String>] [<CommonParameters>]
-URL <String>
Specifies the URL where to download from
Required? false
Position? 1
@ -21,7 +22,7 @@ download-dir.ps1 [[-URL] <String>] [<CommonParameters>]
## Example
```powershell
PS>./download-dir "https://www.cnn.com"
PS>./download-dir https://www.cnn.com
```
## Notes

View File

@ -1,12 +1,13 @@
## download-file.ps1 - Downloads a file from the given URL
## download-file.ps1 - Downloads a file from an URL
download-file.ps1 [<URL>]
This script downloads a file from the given URL
## Parameters
```powershell
download-file.ps1 [[-URL] <String>] [<CommonParameters>]
-URL <String>
Specifies the URL where to download from
Required? false
Position? 1
@ -21,7 +22,7 @@ download-file.ps1 [[-URL] <String>] [<CommonParameters>]
## Example
```powershell
PS>./download-file "https://www.cnn.com/index.html"
PS>./download-file https://www.cnn.com/index.html
```
## Notes

View File

@ -1,12 +1,13 @@
## edit.ps1 - Opens the built-in text editor to edit the given file
## edit.ps1 - Opens an editor to edit a file
edit.ps1 <filename>
Opens a text editor to edit the given file.
## Parameters
```powershell
edit.ps1 [[-Filename] <String>] [<CommonParameters>]
-Filename <String>
Specifies the path to the filename
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## enable-crash-dumps.ps1 - Enables the writing of crash dumps
enable-crash-dumps.ps1
Enables the writing of crash dumps.
## Parameters
```powershell

View File

@ -1,7 +1,6 @@
## enable-god-mode.ps1 - Enables the god mode
Enables the god mode (adds a new icon to the desktop)
enable-god-mode.ps1
This script enables the god mode. It adds a new icon to the desktop.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## encrypt-file.ps1 - Encrypts a file
encrypt-file.ps1 [<Path>] [<Password>]
This script encrypts the given file.
## Parameters
```powershell
encrypt-file.ps1 [[-Path] <String>] [[-Password] <String>] [<CommonParameters>]
-Path <String>
Specifies the path to the file to encrypt
Required? false
Position? 1
@ -15,6 +16,7 @@ encrypt-file.ps1 [[-Path] <String>] [[-Password] <String>] [<CommonParameters>]
Accept wildcard characters? false
-Password <String>
Specifies the password to use
Required? false
Position? 2

View File

@ -1,6 +1,6 @@
## enter-chat.ps1 - Enters a chat using a common network shared file
enter-chat.ps1
This script enters a chat using a common network shared file.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## fetch-repo.ps1 - Fetches updates for a local Git repository (including submodules)
fetch-repo.ps1 [<RepoDir>]
This script fetches updates for a local Git repository (including submodules).
## Parameters
```powershell
@ -23,8 +23,8 @@ fetch-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
## Example
```powershell
PS>./fetch-repo
🢃 Fetching updates for Git repository 📂PowerShell ...
✔️ fetched updates for 📂PowerShell"
🢃 Fetching updates...
✔️ fetched updates for Git repository 📂PowerShell in 14 sec
```
## Notes

View File

@ -1,12 +1,13 @@
## fetch-repos.ps1 - Fetches updates for all Git repositories in a folder (including submodules)
fetch-repos.ps1 [<ParentDir>]
This script fetches updates for all Git repositories in a folder (including submodules).
## Parameters
```powershell
fetch-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
-ParentDir <String>
Specifies the path to the parent folder
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## hibernate.ps1 - Enables hibernate mode for the local computer (needs admin rights)
hibernate.ps1
This script enables hibernate mode for the local computer. It needs admin rights.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## inspect-exe.ps1 - Prints basic information of an executable file
inspect-exe.ps1 [<path-to-exe-file>]
This script prints basic information of an executable file.
## Parameters
```powershell
inspect-exe.ps1 [[-PathToExe] <String>] [<CommonParameters>]
-PathToExe <String>
Specifies the path to the executable file
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## install-github-cli.ps1 - Installs GitHub CLI
install-github-cli.ps1
This script installs GitHub command-line interface (CLI).
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## install-google-chrome.ps1 - Installs the latest Google Chrome browser
install-google-chrome.ps1
This script installs the latest Google Chrome Web browser.
## Parameters
```powershell

View File

@ -1,7 +1,6 @@
## install-knot-resolver.ps1 - Installs Knot Resolver (needs admin rights)
Knot Resolver is a DNS resolver daemon.
install-knot-resolver.ps1
This script installs Knot Resolver. Knot Resolver is a DNS resolver daemon. It needs admin rights.
## Parameters
```powershell

View File

@ -1,13 +1,13 @@
## install-signal-cli.ps1 - Installs signal-cli
Installs signal-cli from github.com/AsamK/signal-cli. See the Web page for the correct version number
install-signal-cli.ps1 [<version>]
Installs signal-cli from github.com/AsamK/signal-cli. See the Web page for the correct version number.
## Parameters
```powershell
install-signal-cli.ps1 [[-Version] <String>] [<CommonParameters>]
-Version <String>
Specifies the version to install
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## install-ssh-client.ps1 - Installs the SSH client (needs admin rights)
install-ssh-client.ps1
This script installs the SSH client (needs admin rights).
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## install-ssh-server.ps1 - Installs the SSH server (needs admin rights)
install-ssh-server.ps1
This script installs the SSH server (needs admin rights).
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## install-updates.ps1 - Installs updates for the local machine (needs admin rights)
install-updates.ps1
This script installs updates for the local machine (needs admin rights).
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## install-wsl.ps1 - Installs Windows Subsystem for Linux (needs admin rights)
install-wsl.ps1
This script installs Windows Subsystem for Linux. It needs admin rights.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## introduce-powershell.ps1 - Introduces PowerShell to new users
introduce-powershell.ps1
This script introduces PowerShell to new users.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## locate-city.ps1 - Prints the geographic location of the given city
## locate-city.ps1 - Prints the geographic location of a city
locate-city.ps1 [<City>]
This script prints the geographic location of the given city.
## Parameters
```powershell
locate-city.ps1 [[-City] <String>] [<CommonParameters>]
-City <String>
Specifies the city to look for
Required? false
Position? 1

View File

@ -1,33 +1,13 @@
## locate-ipaddress.ps1 - Prints the geographic location of the given IP address
## locate-ipaddress.ps1 - locate-ipaddress.ps1 [[-IPaddress] <string>]
locate-ipaddress.ps1 [<IPaddress>]
## Parameters
```powershell
locate-ipaddress.ps1 [[-IPaddress] <String>] [<CommonParameters>]
-IPaddress <String>
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
PS>./locate-ipaddress 177.144.67.98
```
## Notes
Author: Markus Fleschutz · License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of locate-ipaddress.ps1*

View File

@ -1,12 +1,13 @@
## locate-zip-code.ps1 - Prints the geographic location of the given zip-code
## locate-zip-code.ps1 - Prints the geo location of a zip-code
locate-zip-code.ps1 [<CountryCode>] [<ZipCode>]
This script prints the geographic location of the given zip-code.
## Parameters
```powershell
locate-zip-code.ps1 [[-CountryCode] <String>] [[-ZipCode] <String>] [<CommonParameters>]
-CountryCode <String>
Specifies the country code
Required? false
Position? 1
@ -15,6 +16,7 @@ locate-zip-code.ps1 [[-CountryCode] <String>] [[-ZipCode] <String>] [<CommonPara
Accept wildcard characters? false
-ZipCode <String>
Specifies the zip code
Required? false
Position? 2

View File

@ -1,6 +1,6 @@
## make-install.ps1 - Copies newer EXE's + DLL's from the build directory to the installation directory
make-install.ps1 <BuildDir>
This script copies newer EXE's + DLL's from the build directory to the installation directory.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## moon.ps1 - Prints the current moon phase
moon.ps1
This script prints the current moon phase.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## new-branch.ps1 - Creates and switches to a new branch in a Git repository
new-branch.ps1 [<BranchName>] [<RepoDir>]
This script creates and switches to a new branch in a Git repository.
## Parameters
```powershell
new-branch.ps1 [[-BranchName] <String>] [[-RepoDir] <String>] [<CommonParameters>]
-BranchName <String>
Specifies the branch name
Required? false
Position? 1
@ -15,6 +16,7 @@ new-branch.ps1 [[-BranchName] <String>] [[-RepoDir] <String>] [<CommonParameters
Accept wildcard characters? false
-RepoDir <String>
Specifies the path to the Git repository
Required? false
Position? 2

View File

@ -1,12 +1,13 @@
## new-email.ps1 - Opens the default email client to write a new email
new-email.ps1 [<address>]
This script opens the default email client to write a new email.
## Parameters
```powershell
new-email.ps1 [[-EmailAddress] <String>] [<CommonParameters>]
-EmailAddress <String>
Specifies the email address fill in
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## new-qrcode.ps1 - Generates a new QR code image file
new-qrcode.ps1 [<Text>] [<ImageSize>]
This script generates a new QR code image file.
## Parameters
```powershell
new-qrcode.ps1 [[-Text] <String>] [[-ImageSize] <String>] [<CommonParameters>]
-Text <String>
Specifies the text to use
Required? false
Position? 1
@ -15,6 +16,7 @@ new-qrcode.ps1 [[-Text] <String>] [[-ImageSize] <String>] [<CommonParameters>]
Accept wildcard characters? false
-ImageSize <String>
Specifies the image size (width x height)
Required? false
Position? 2

View File

@ -1,13 +1,13 @@
## new-script.ps1 - Creates a new PowerShell script file
Creates a new PowerShell script file (by using template file ../Data/template.ps1).
new-script.ps1 [<filename>]
## Parameters
```powershell
new-script.ps1 [[-filename] <String>] [<CommonParameters>]
-filename <String>
Specifies the path to the resulting file
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## new-shortcut.ps1 - Creates a new shortcut file
new-shortcut.ps1 [<shortcut>] [<target>] [<description>]
This script creates a new shortcut file.
## Parameters
```powershell
new-shortcut.ps1 [[-shortcut] <String>] [[-target] <String>] [[-description] <String>] [<CommonParameters>]
-shortcut <String>
Specifies the shortcut filename
Required? false
Position? 1
@ -15,6 +16,7 @@ new-shortcut.ps1 [[-shortcut] <String>] [[-target] <String>] [[-description] <St
Accept wildcard characters? false
-target <String>
Specifies the path to the target
Required? false
Position? 2
@ -23,6 +25,7 @@ new-shortcut.ps1 [[-shortcut] <String>] [[-target] <String>] [[-description] <St
Accept wildcard characters? false
-description <String>
Specifies a description
Required? false
Position? 3

View File

@ -1,12 +1,13 @@
## new-tag.ps1 - Creates a new tag in a Git repository
new-tag.ps1 [<TagName>] [<RepoDir>]
This script creates a new tag in a Git repository.
## Parameters
```powershell
new-tag.ps1 [[-TagName] <String>] [[-RepoDir] <String>] [<CommonParameters>]
-TagName <String>
Specifies the new tag name
Required? false
Position? 1
@ -15,6 +16,7 @@ new-tag.ps1 [[-TagName] <String>] [[-RepoDir] <String>] [<CommonParameters>]
Accept wildcard characters? false
-RepoDir <String>
Specifies the path to the Git repository
Required? false
Position? 2

View File

@ -1,12 +1,13 @@
## new-zipfile.ps1 - Creates a new .ZIP file from a folder (including subfolders)
new-zipfile.ps1 [<folder>]
This script creates a new .ZIP file from a folder (including subfolders).
## Parameters
```powershell
new-zipfile.ps1 [[-folder] <String>] [<CommonParameters>]
-folder <String>
Specifies the path to the folder
Required? false
Position? 1

View File

@ -1,13 +1,13 @@
## open-browser.ps1 - Opens the default Web browser
Opens the default Web browser, optional with given URL
open-browser.ps1 [<URL>]
This script opens the default Web browser, optional with given URL.
## Parameters
```powershell
open-browser.ps1 [[-URL] <String>] [<CommonParameters>]
-URL <String>
Specifies the URL
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## open-calculator.ps1 - Starts the calculator application
## open-calculator.ps1 - Starts the calculator app
open-calculator.ps1
This script starts the calculator application.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## open-email-client.ps1 - Starts the default email client
open-email-client.ps1
This script starts the default email client.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## open-file-explorer.ps1 - Starts the File Explorer
open-file-explorer.ps1
This script starts the File Explorer.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## open-netflix.ps1 - Starts the Netflix app (needs to be installed)
## open-netflix.ps1 - Starts the Netflix app
open-netflix.ps1
This script starts the Netflix application.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## open-onedrive.ps1 - Opens the user's OneDrive folder
open-onedrive.ps1
This script opens the user's OneDrive folder.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## open-recycle-bin.ps1 - Starts the File Explorer with the recycle bin folder
open-recycle-bin.ps1
This script starts the File Explorer with the recycle bin folder.
## Parameters
```powershell

View File

@ -1,6 +1,5 @@
## pick-commit.ps1 - Cherry-picks a Git commit into one or more branches
pick-commit.ps1 [<CommitID>] [<CommitMessage>] [<Branches>] [<RepoDir>]
Cherry-picks a Git commit into one or more branches (branch names need to be separated by spaces)
NOTE: in case of merge conflicts the script stops immediately!
@ -9,6 +8,7 @@ NOTE: in case of merge conflicts the script stops immediately!
pick-commit.ps1 [[-CommitID] <String>] [[-CommitMessage] <String>] [[-Branches] <String>] [[-RepoDir] <String>] [<CommonParameters>]
-CommitID <String>
Specifies the commit ID
Required? false
Position? 1
@ -17,6 +17,7 @@ pick-commit.ps1 [[-CommitID] <String>] [[-CommitMessage] <String>] [[-Branches]
Accept wildcard characters? false
-CommitMessage <String>
Specifies the commit message to use
Required? false
Position? 2
@ -25,6 +26,7 @@ pick-commit.ps1 [[-CommitID] <String>] [[-CommitMessage] <String>] [[-Branches]
Accept wildcard characters? false
-Branches <String>
Specifies the list of branches, separated by spaces
Required? false
Position? 3
@ -33,6 +35,7 @@ pick-commit.ps1 [[-CommitID] <String>] [[-CommitMessage] <String>] [[-Branches]
Accept wildcard characters? false
-RepoDir <String>
Specifies the path to the Git repository
Required? false
Position? 4

View File

@ -1,12 +1,13 @@
## play-files.ps1 - Plays the given audio files (supporting MP3 and WAV format)
## play-files.ps1 - Plays audio files (MP3 and WAV)
play-files.ps1 [<FilePattern>]
This script plays the given audio files (supporting MP3 and WAV format).
## Parameters
```powershell
play-files.ps1 [[-FilePattern] <String>] [<CommonParameters>]
-FilePattern <String>
Specifies the file pattern
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## play-jingle-bells.ps1 - Plays Jingle Bells
play-jingle-bells.ps1
This script plays Jingle Bells.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## play-m3u.ps1 - Plays the given playlist (in .M3U file format)
## play-m3u.ps1 - Plays a playlist (.M3U format)
play-m3u.ps1 [<filename>]
This script plays the given playlist (in .M3U file format)
## Parameters
```powershell
play-m3u.ps1 [[-filename] <String>] [<CommonParameters>]
-filename <String>
Specifies the path to the playlist
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## play-mission-impossible.ps1 - Plays the Mission Impossible theme
play-mission-impossible.ps1
This script plays the Mission Impossible theme.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## play-mp3.ps1 - Plays a sound file (in MP3 file format)
## play-mp3.ps1 - Plays a sound file (MP3 format)
play-mp3.ps1 [<MP3-file>]
This script plays a sound file (in .MP3 file format).
## Parameters
```powershell
play-mp3.ps1 [[-Filename] <String>] [<CommonParameters>]
-Filename <String>
Specifies the path to the .MP3 file
Required? false
Position? 1

View File

@ -1,6 +1,6 @@
## play-super-mario.ps1 - Plays the Super Mario intro
play-super-mario.ps1
This script plays the Super Mario intro.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## play-tetris-melody.ps1 - Plays the Tetris melody
play-tetris-melody.ps1
This script plays the Tetris melody.
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## poweroff.ps1 - Halts the local computer (needs admin rights)
poweroff.ps1
This script halts the local computer. It needs admin rights.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## publish-to-ipfs.ps1 - Publishes the given files & folders to IPFS
## publish-to-ipfs.ps1 - Publishes files & folders to IPFS
publish-to-ipfs.ps1 [<FilePattern>] [<HashList>]
This script publishes the given files and folders to IPFS.
## Parameters
```powershell
publish-to-ipfs.ps1 [[-FilePattern] <String>] [[-HashList] <String>] [[-DF_Hashes] <String>] [<CommonParameters>]
-FilePattern <String>
Specifies the file pattern
Required? false
Position? 1
@ -15,6 +16,7 @@ publish-to-ipfs.ps1 [[-FilePattern] <String>] [[-HashList] <String>] [[-DF_Hashe
Accept wildcard characters? false
-HashList <String>
Specifies the path to the resulting hash list
Required? false
Position? 2
@ -23,6 +25,7 @@ publish-to-ipfs.ps1 [[-FilePattern] <String>] [[-HashList] <String>] [[-DF_Hashe
Accept wildcard characters? false
-DF_Hashes <String>
Specifies the path to the resulting digital forensic hashes
Required? false
Position? 3

View File

@ -1,12 +1,13 @@
## pull-repo.ps1 - Pulls updates for a local Git repository (including submodules)
## pull-repo.ps1 - Pulls updates for a Git repository (including submodules)
pull-repo.ps1 [<repo-dir>]
This script pulls updates for a local Git repository (including submodules).
## Parameters
```powershell
pull-repo.ps1 [[-RepoDir] <String>] [<CommonParameters>]
-RepoDir <String>
Specifies the path to the Git repository
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## pull-repos.ps1 - Pulls updates for all Git repositories in a folder (including submodules)
pull-repos.ps1 [<ParentDir>]
This script pulls updates for all Git repositories in a folder (including submodules).
## Parameters
```powershell
pull-repos.ps1 [[-ParentDir] <String>] [<CommonParameters>]
-ParentDir <String>
Specifies the path to the parent folder
Required? false
Position? 1

View File

@ -1,9 +1,7 @@
## query-smart-data.ps1 - Queries and saves the S.M.A.R.T. data of your HDD's/SSD's
query-smart-data.ps1 [<directory>]
Queries the S.M.A.R.T. data of your HDD/SSD's and saves it to the current/given directory
Queries the S.M.A.R.T. data of your HDD/SSD's and saves it to the current/given directory.
(use smart-data2csv.ps1 to generate a CSV table for analysis).
Requires smartctl (smartmontools) and admin rights. For automation copy this script to /etc/cron.daily
## Parameters
@ -11,6 +9,7 @@ Queries the S.M.A.R.T. data of your HDD/SSD's and saves it to the current/given
query-smart-data.ps1 [[-Directory] <String>] [<CommonParameters>]
-Directory <String>
Specifies the path to the target directory
Required? false
Position? 1

View File

@ -1,12 +1,13 @@
## reboot-fritzbox.ps1 - Reboots the FRITZ!Box device
reboot-fritzbox.ps1 [<Username>] [<Password>]
This script reboots the FRITZ!Box device
## Parameters
```powershell
reboot-fritzbox.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParameters>]
-Username <String>
Specifies the user name
Required? false
Position? 1
@ -15,6 +16,7 @@ reboot-fritzbox.ps1 [[-Username] <String>] [[-Password] <String>] [<CommonParame
Accept wildcard characters? false
-Password <String>
Specifies the password
Required? false
Position? 2

View File

@ -1,6 +1,6 @@
## reboot.ps1 - Reboots the local computer (needs admin rights)
reboot.ps1
This script reboots the local computer (needs admin rights).
## Parameters
```powershell

View File

@ -1,6 +1,6 @@
## remind-me.ps1 - Creates a scheduled task that will display a popup message
remind-me.ps1
This script creates a scheduled task that will display a popup message.
## Parameters
```powershell

View File

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

View File

@ -1,6 +1,6 @@
## remove-print-jobs.ps1 - Removes all jobs from all printers
remove-print-jobs.ps1
This script removes all print jobs from all printer devices.
## Parameters
```powershell

View File

@ -1,12 +1,13 @@
## remove-tag.ps1 - Removes a Git tag (locally, remote, or both)
remove-tag.ps1 [<TagName>] [<Mode>] [<RepoDir>]
This script removes a Git tag, either locally, remote, or both.
## Parameters
```powershell
remove-tag.ps1 [[-TagName] <String>] [[-Mode] <String>] [[-RepoDir] <String>] [<CommonParameters>]
-TagName <String>
Specifies the Git tag name
Required? false
Position? 1
@ -15,6 +16,7 @@ remove-tag.ps1 [[-TagName] <String>] [[-Mode] <String>] [[-RepoDir] <String>] [<
Accept wildcard characters? false
-Mode <String>
Specifies either locally, remote, or both
Required? false
Position? 2
@ -23,6 +25,7 @@ remove-tag.ps1 [[-TagName] <String>] [[-Mode] <String>] [[-RepoDir] <String>] [<
Accept wildcard characters? false
-RepoDir <String>
Specifies the path to the Git repository
Required? false
Position? 3

View File

@ -1,12 +1,13 @@
## replace-in-files.ps1 - Search and replace a pattern in the given files by the replacement
replace-in-files.ps1 [<pattern>] [<replacement>] [<files>]
This script searches and replaces a pattern in the given files by the replacement.
## Parameters
```powershell
replace-in-files.ps1 [[-pattern] <String>] [[-replacement] <String>] [[-files] <String>] [<CommonParameters>]
-pattern <String>
Specifies the pattern to look for
Required? false
Position? 1
@ -15,6 +16,7 @@ replace-in-files.ps1 [[-pattern] <String>] [[-replacement] <String>] [[-files] <
Accept wildcard characters? false
-replacement <String>
Specifies the replacement
Required? false
Position? 2
@ -23,6 +25,7 @@ replace-in-files.ps1 [[-pattern] <String>] [[-replacement] <String>] [[-files] <
Accept wildcard characters? false
-files <String>
Specifies the file to scan
Required? false
Position? 3

View File

@ -1,6 +1,6 @@
## restart-network-adapters.ps1 - Restarts all local network adapters (needs admin rights)
restart-network-adapters.ps1
This script restarts all local network adapters (needs admin rights).
## Parameters
```powershell

Some files were not shown because too many files have changed in this diff Show More