PowerShell/Docs/check-symlinks.md

38 lines
1.0 KiB
Markdown
Raw Normal View History

2021-10-06 13:00:03 +02:00
## check-symlinks.ps1 - Checks every symlink in a folder (including subfolders)
2021-09-28 11:56:17 +02:00
2021-10-16 16:50:10 +02:00
This script checks every symlink in a folder (including subfolders).
2021-10-06 10:46:35 +02:00
Returns the number of broken symlinks as exit value.
2021-09-28 11:56:17 +02:00
2021-10-06 11:11:20 +02:00
## Parameters
2021-09-28 11:56:17 +02:00
```powershell
2021-10-06 11:11:20 +02:00
check-symlinks.ps1 [[-folder] <String>] [<CommonParameters>]
2021-10-06 10:46:35 +02:00
-folder <String>
2021-10-16 16:50:10 +02:00
Specifies the path to the directory tree
2021-09-28 11:56:17 +02:00
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
2021-10-06 13:16:21 +02:00
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
2021-09-28 11:56:17 +02:00
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
```
## Example
```powershell
2021-10-17 11:56:55 +02:00
PS> ./check-symlinks .
2021-10-06 10:46:35 +02:00
✔️ 0 out of 10 symlinks are broken in 📂/home/markus
2021-10-17 11:56:55 +02:00
2021-09-28 11:56:17 +02:00
```
## Notes
Author: Markus Fleschutz · License: CC0
## Related Links
https://github.com/fleschutz/PowerShell
*Generated by convert-ps2md.ps1 using the comment-based help of check-symlinks.ps1*