extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-08-09 13:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated the manuals

Browse Source
This commit is contained in:
Markus Fleschutz
2024-03-27 17:36:59 +01:00
parent c5b5cb1c6e
commit aed2b7d940
610 changed files with 1754 additions and 1120 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
docs/write-powershell-profile.md
View File

@ -6,7 +6,16 @@ This PowerShell script writes the PowerShell profile for the current user.
Parameters
----------
```powershell
PS> ./write-powershell-profile.ps1 [<CommonParameters>]
PS> ./write-powershell-profile.ps1 [[-path] <String>] [<CommonParameters>]
-path <String>
Specifies the path to the new profile ($PSScriptRoot/my-profile.ps1 by default)
Required? false
Position? 1
Default value "$PSScriptRoot/my-profile.ps1"
Accept pipeline input? false
Accept wildcard characters? false
[<CommonParameters>]
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
@ -17,6 +26,10 @@ Example
-------
```powershell
PS> ./write-powershell-profile.ps1
⏳ (1/2) Querying path to profile 'CurrentUserCurrentHost'...
C:\Users\Markus\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1
⏳ (2/2) Copying file 'my-profile.ps1'...
✔️ New PowerShell profile written - it gets active on next login
```
@ -33,28 +46,36 @@ Script Content
```powershell
<#
.SYNOPSIS
Writes the user's PowerShell profile
Writes the PowerShell profile
.DESCRIPTION
This PowerShell script writes the PowerShell profile for the current user.
.PARAMETER path
Specifies the path to the new profile ($PSScriptRoot/my-profile.ps1 by default)
.EXAMPLE
PS> ./write-powershell-profile.ps1
⏳ (1/2) Querying path to profile 'CurrentUserCurrentHost'...
C:\Users\Markus\Documents\WindowsPowerShell\Microsoft.PowerShell_profile.ps1
⏳ (2/2) Copying file 'my-profile.ps1'...
✔️ New PowerShell profile written - it gets active on next login
.LINK
https://github.com/fleschutz/PowerShell
.NOTES
Author: Markus Fleschutz | License: CC0
#>
param([string]$path = "$PSScriptRoot/my-profile.ps1")
try {
"⏳ (1/3) Querying path to PowerShell profile 'CurrentUserCurrentHost'..."
"⏳ (1/2) Querying path to profile 'CurrentUserCurrentHost'..."
$pathToProfile = $PROFILE.CurrentUserCurrentHost
" $pathToProfile"
"⏳ (2/3) Creating the profile (if non-existent)..."
$filename = (Get-Item "$path").Name
"⏳ (2/2) Copying file '$filename'..."
$null = New-Item -Path $pathToProfile -ItemType "file" -Force
Copy-Item "$path" "$pathToProfile" -force
"⏳ (3/3) Updating the profile by my-profile.ps1..."
Copy-Item "$PSScriptRoot/my-profile.ps1" "$pathToProfile" -force
"✔️ Updated your PowerShell profile - it gets active on next login"
"✔️ New PowerShell profile written - it gets active on next login"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
@ -62,4 +83,4 @@ try {
}
```
*(generated by convert-ps2md.ps1 using the comment-based help of write-powershell-profile.ps1 as of 01/25/2024 13:58:43)*
*(generated by convert-ps2md.ps1 using the comment-based help of write-powershell-profile.ps1 as of 03/27/2024 17:36:33)*