mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-16 23:51:18 +02:00
Rename the docs file
This commit is contained in:
65
Docs/configure-git.ps1.md
Normal file
65
Docs/configure-git.ps1.md
Normal file
@ -0,0 +1,65 @@
|
||||
# PowerShell Script /home/mf/PowerShell/Scripts/configure-git.ps1
|
||||
|
||||
## Synopsis
|
||||
configure-git.ps1 [<full-name>] [<email-address>] [<favorite-editor>]
|
||||
|
||||
## Description
|
||||
Sets up the Git user configuration
|
||||
|
||||
## Syntax
|
||||
```powershell
|
||||
/home/mf/PowerShell/Scripts/configure-git.ps1 [[-FullName] <String>] [[-EmailAddress] <String>] [[-FavoriteEditor] <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
## -FullName <String> Parameter
|
||||
|
||||
```
|
||||
-FullName <String>
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
Default value
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
```
|
||||
|
||||
## -EmailAddress <String> Parameter
|
||||
|
||||
```
|
||||
-EmailAddress <String>
|
||||
|
||||
Required? false
|
||||
Position? 2
|
||||
Default value
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
```
|
||||
|
||||
## -FavoriteEditor <String> Parameter
|
||||
|
||||
```
|
||||
-FavoriteEditor <String>
|
||||
|
||||
Required? false
|
||||
Position? 3
|
||||
Default value
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
```
|
||||
## <CommonParameters>
|
||||
This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).
|
||||
|
||||
## Example
|
||||
```powershell
|
||||
PS>.\configure-git.ps1
|
||||
```
|
||||
|
||||
|
||||
## Notes
|
||||
Author: Markus Fleschutz
|
||||
License: CC0
|
||||
|
||||
## Related Links
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
*Created by convert-ps2md.ps1*
|
Reference in New Issue
Block a user