mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-18 00:20:09 +02:00
Update the manuals in Docs/
This commit is contained in:
35
Docs/edit.md
35
Docs/edit.md
@@ -1,4 +1,4 @@
|
||||
## edit.ps1 - Opens an editor to edit a file
|
||||
## The edit.ps1 PowerShell Script
|
||||
|
||||
This PowerShell script opens a text editor to edit the given file.
|
||||
|
||||
@@ -32,4 +32,37 @@ Author: Markus Fleschutz | License: CC0
|
||||
## Related Links
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
## Source Code
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Opens an editor to edit a file
|
||||
.DESCRIPTION
|
||||
This PowerShell script opens a text editor to edit the given file.
|
||||
.PARAMETER Filename
|
||||
Specifies the path to the filename
|
||||
.EXAMPLE
|
||||
PS> ./edit C:\MyFile.txt
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$Filename = "")
|
||||
|
||||
try {
|
||||
if ($IsLinux) {
|
||||
& vi "$Filename"
|
||||
if ($lastExitCode -ne "0") { throw "Can't execute 'vi' - make sure vi is installed and available" }
|
||||
} else {
|
||||
& notepad.exe "$Filename"
|
||||
if ($lastExitCode -ne "0") { throw "Can't execute 'notepad.exe' - make sure notepad.exe is installed and available" }
|
||||
}
|
||||
|
||||
exit 0 # success
|
||||
} catch {
|
||||
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
||||
exit 1
|
||||
}
|
||||
|
||||
*Generated by convert-ps2md.ps1 using the comment-based help of edit.ps1*
|
||||
|
Reference in New Issue
Block a user