mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-16 15:41:52 +02:00
Rename folder Docs to docs
This commit is contained in:
71
docs/list-files.md
Normal file
71
docs/list-files.md
Normal file
@ -0,0 +1,71 @@
|
||||
*list-files.ps1*
|
||||
================
|
||||
|
||||
This PowerShell script lists all files within the given directory tree.
|
||||
|
||||
Parameters
|
||||
----------
|
||||
```powershell
|
||||
PS> ./list-files.ps1 [[-DirTree] <String>] [<CommonParameters>]
|
||||
|
||||
-DirTree <String>
|
||||
Specifies the path to the directory tree
|
||||
|
||||
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> ./list-files.ps1 C:\
|
||||
|
||||
```
|
||||
|
||||
Notes
|
||||
-----
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
|
||||
Related Links
|
||||
-------------
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
Script Content
|
||||
--------------
|
||||
```powershell
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Lists all files in a directory tree
|
||||
.DESCRIPTION
|
||||
This PowerShell script lists all files within the given directory tree.
|
||||
.PARAMETER DirTree
|
||||
Specifies the path to the directory tree
|
||||
.EXAMPLE
|
||||
PS> ./list-files.ps1 C:\
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$DirTree = "")
|
||||
|
||||
try {
|
||||
if ($DirTree -eq "" ) { $DirTree = read-host "Enter path to directory tree" }
|
||||
|
||||
Get-ChildItem -path $DirTree -recurse | select FullName
|
||||
exit 0 # success
|
||||
} catch {
|
||||
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
||||
exit 1
|
||||
}
|
||||
```
|
||||
|
||||
*(generated by convert-ps2md.ps1 using the comment-based help of list-files.ps1 as of 10/19/2023 08:11:39)*
|
Reference in New Issue
Block a user