Rename folder Docs to docs

2025-08-19 08:52:05 +02:00 · 2023-10-31 11:05:01 +01:00
parent 0915de8f8b
commit 893273739a
900 changed files with 304 additions and 304 deletions
--- a/docs/check-symlinks.md
+++ b/docs/check-symlinks.md
@@ -0,0 +1,103 @@
+*check-symlinks.ps1*
+================
+
+This PowerShell script checks every symbolic link in a folder (including subfolders).
+It returns the number of broken symlinks as exit value.
+
+Parameters
+----------
+```powershell
+PS> ./check-symlinks.ps1 [[-Folder] <String>] [<CommonParameters>]
+
+-Folder <String>
+    Specifies the path to the folder
+    
+    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> ./check-symlinks C:\Users
+⏳ Checking symlinks at 📂C:\Users including subfolders...
+✔️ Found 0 broken symlinks at 📂C:\Users in 60 sec
+
+```
+
+Notes
+-----
+Author: Markus Fleschutz | License: CC0
+
+Related Links
+-------------
+https://github.com/fleschutz/PowerShell
+
+Script Content
+--------------
+```powershell
+<#
+.SYNOPSIS
+	Checks symlinks in a folder
+.DESCRIPTION
+	This PowerShell script checks every symbolic link in a folder (including subfolders).
+	It returns the number of broken symlinks as exit value.
+.PARAMETER folder
+	Specifies the path to the folder
+.EXAMPLE
+	PS> ./check-symlinks C:\Users
+	⏳ Checking symlinks at 📂C:\Users including subfolders...
+	✔️ Found 0 broken symlinks at 📂C:\Users in 60 sec
+.LINK
+	https://github.com/fleschutz/PowerShell
+.NOTES
+	Author: Markus Fleschutz | License: CC0
+#>
+
+param([string]$Folder = "")
+
+try {
+	if ($Folder -eq "" ) { $Folder = read-host "Enter the path to the folder" }
+
+	$StopWatch = [system.diagnostics.stopwatch]::startNew()
+	$FullPath = Resolve-Path "$Folder"
+	"⏳ Checking symlinks at 📂$FullPath including subfolders..."
+
+	[int]$NumTotal = [int]$NumBroken = 0
+	Get-ChildItem $FullPath -recurse  | Where { $_.Attributes -match "ReparsePoint" } | ForEach-Object {
+		$Symlink = $_.FullName
+		$Target = ($_ | Select-Object -ExpandProperty Target -ErrorAction Ignore)
+		if ($Target) {
+			$path = $_.FullName + "\..\" + ($_ | Select-Object -ExpandProperty Target)
+			$item = Get-Item $path -ErrorAction Ignore
+			if (!$item) {
+				$NumBroken++
+				"Symlink $Symlink to: $Target seems broken (#$NumBroken)"
+			}
+		}
+		$NumTotal++
+	}
+
+	[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
+	if ($NumTotal -eq 0) {
+		"✔️ No symlink found at 📂$FullPath in $Elapsed sec" 
+	} elseif ($NumBroken -eq 1) {
+		"✔️ Found $NumBroken broken symlink at 📂$FullPath in $Elapsed sec"
+	} else {
+		"✔️ Found $NumBroken broken symlinks at 📂$FullPath in $Elapsed sec"
+	}
+	exit $NumBroken
+} catch {
+	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	exit 1
+}
+```
+
+*(generated by convert-ps2md.ps1 using the comment-based help of check-symlinks.ps1 as of 10/19/2023 08:11:36)*