Skip to content

Commit 73037be

Browse files
fleschutzfleschutz
committed
Update the comment based help
1 parent c296024 commit 73037be

305 files changed

Lines changed: 820 additions & 474 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Docs/check-file-system.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
## check-file-system.ps1 - Checks the file system of a drive (needs admin rights)
22

3-
check-file-system.ps1 [<drive>]
3+
This script checks the file system of a drive. It needs admin rights.
44

55
## Parameters
66
```powershell
77
check-file-system.ps1 [[-Drive] <String>] [<CommonParameters>]
88
99
-Drive <String>
10+
Specifies the drive to check
1011
1112
Required? false
1213
Position? 1

‎Docs/check-health.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## check-health.ps1 - Checks the health of the local computer
22

3-
check-health.ps1
3+
This script checks the health of the local computer.
44

55
## Parameters
66
```powershell

‎Docs/check-ipv4-address.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
## check-ipv4-address.ps1 - Checks the given IPv4 address for validity
1+
## check-ipv4-address.ps1 - Checks an IPv4 address for validity
22

3-
check-ipv4-address.ps1 [<Address>]
3+
This script checks the given IPv4 address for validity.
44

55
## Parameters
66
```powershell
77
check-ipv4-address.ps1 [[-Address] <String>] [<CommonParameters>]
88
99
-Address <String>
10+
Specifies the IPv4 address to check
1011
1112
Required? false
1213
Position? 1

‎Docs/check-ipv6-address.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
1-
## check-ipv6-address.ps1 - Checks the given IPv6 address for validity
1+
## check-ipv6-address.ps1 - Checks an IPv6 address for validity
22

3-
check-ipv6-address.ps1 [<Address>]
3+
This script checks the given IPv6 address for validity
44

55
## Parameters
66
```powershell
77
check-ipv6-address.ps1 [[-Address] <String>] [<CommonParameters>]
88
99
-Address <String>
10+
Specifies the IPv6 address to check
1011
1112
Required? false
1213
Position? 1

‎Docs/check-mac-address.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
## check-mac-address.ps1 - Checks the given MAC address for validity
22

3+
This script checks the given MAC address for validity
34
Supported MAC address formats are: 00:00:00:00:00:00 or 00-00-00-00-00-00 or 000000000000.
4-
check-mac-address.ps1 [<MAC>]
55

66
## Parameters
77
```powershell
88
check-mac-address.ps1 [[-MAC] <String>] [<CommonParameters>]
99
1010
-MAC <String>
11+
Specifies the MAC address to check
1112
1213
Required? false
1314
Position? 1

‎Docs/check-ping.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
## check-ping.ps1 - Checks the ping latency from the local computer to selected Internet hosts
22

3-
Hosts by default are: amazon.com,apple.com,bing.com,cnn.com,dropbox.com,facebook.com,google.com,live.com,twitter.com,youtube.com
4-
check-ping.ps1 [<hosts>]
3+
This script checks the ping latency from the local computer to selected Internet hosts.
4+
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
55

66
## Parameters
77
```powershell
88
check-ping.ps1 [[-hosts] <String>] [<CommonParameters>]
99
1010
-hosts <String>
11+
Specifies the hosts to check (separated by comma)
1112
1213
Required? false
1314
Position? 1

‎Docs/check-smart-devices.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
## check-smart-devices.ps1 - Performs a selftest on your S.M.A.R.T. HDD/SSD devices.
22

3-
check-smart-devices.ps1 [<type>]
4-
Type is either short(default) or long.
5-
Requires smartctl (smartmontools package) and admin rights.
3+
This script performs a selftest on your S.M.A.R.T. HDD/SSD devices.
4+
It requires smartctl (smartmontools package) and admin rights.
65

76
## Parameters
87
```powershell
98
check-smart-devices.ps1 [[-type] <String>] [<CommonParameters>]
109
1110
-type <String>
11+
Specifies the type of selftest: either short (default) or long
1212
1313
Required? false
1414
Position? 1

‎Docs/check-subnet-mask.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
## check-subnet-mask.ps1 - Checks the given subnet mask for validity
22

3-
check-subnet-mask.ps1 [<address>]
3+
This script checks the given subnet mask for validity.
44

55
## Parameters
66
```powershell
77
check-subnet-mask.ps1 [[-address] <String>] [<CommonParameters>]
88
99
-address <String>
10+
Specifies the subnet mask to check
1011
1112
Required? false
1213
Position? 1

‎Docs/check-swap-space.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
## check-swap-space.ps1 - Checks the free swap space
22

3-
check-swap-space.ps1 [<min-level>]
3+
This script checks the free swap space.
44

55
## Parameters
66
```powershell
77
check-swap-space.ps1 [[-MinLevel] <Int32>] [<CommonParameters>]
88
99
-MinLevel <Int32>
10+
Specifies the minimum level (50 GB by default)
1011
1112
Required? false
1213
Position? 1

‎Docs/check-symlinks.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
## check-symlinks.ps1 - Checks every symlink in a folder (including subfolders)
22

3-
check-symlinks.ps1 [<folder>]
3+
This script checks every symlink in a folder (including subfolders).
44
Returns the number of broken symlinks as exit value.
55

66
## Parameters
77
```powershell
88
check-symlinks.ps1 [[-folder] <String>] [<CommonParameters>]
99
1010
-folder <String>
11+
Specifies the path to the directory tree
1112
1213
Required? false
1314
Position? 1

0 commit comments

Comments
 (0)