mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-08 20:54:38 +02:00
Rename folder Docs to docs
This commit is contained in:
75
docs/new-script.md
Normal file
75
docs/new-script.md
Normal file
@ -0,0 +1,75 @@
|
||||
*new-script.ps1*
|
||||
================
|
||||
|
||||
This PowerShell script creates a new PowerShell script file (by using template file ../Data/template.ps1).
|
||||
|
||||
Parameters
|
||||
----------
|
||||
```powershell
|
||||
PS> ./new-script.ps1 [[-filename] <String>] [<CommonParameters>]
|
||||
|
||||
-filename <String>
|
||||
Specifies the path to the resulting file
|
||||
|
||||
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> ./new-script myscript.ps1
|
||||
✔️ created new PowerShell script: myscript.ps1
|
||||
|
||||
```
|
||||
|
||||
Notes
|
||||
-----
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
|
||||
Related Links
|
||||
-------------
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
Script Content
|
||||
--------------
|
||||
```powershell
|
||||
<#
|
||||
.SYNOPSIS
|
||||
Creates a new PowerShell script file
|
||||
.DESCRIPTION
|
||||
This PowerShell script creates a new PowerShell script file (by using template file ../Data/template.ps1).
|
||||
.PARAMETER filename
|
||||
Specifies the path to the resulting file
|
||||
.EXAMPLE
|
||||
PS> ./new-script myscript.ps1
|
||||
✔️ created new PowerShell script: myscript.ps1
|
||||
.LINK
|
||||
https://github.com/fleschutz/PowerShell
|
||||
.NOTES
|
||||
Author: Markus Fleschutz | License: CC0
|
||||
#>
|
||||
|
||||
param([string]$filename = "")
|
||||
|
||||
try {
|
||||
if ($filename -eq "" ) { $filename = Read-Host "Enter the new filename" }
|
||||
|
||||
Copy-Item "$PSScriptRoot/../Data/template.ps1" "$filename"
|
||||
|
||||
"✔️ created new PowerShell script: $filename"
|
||||
exit 0 # success
|
||||
} catch {
|
||||
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
||||
exit 1
|
||||
}
|
||||
```
|
||||
|
||||
*(generated by convert-ps2md.ps1 using the comment-based help of new-script.ps1 as of 10/19/2023 08:11:40)*
|
Reference in New Issue
Block a user