mirror of
https://github.com/fleschutz/PowerShell.git
synced 2025-08-09 13:04:59 +02:00
Update the documentation
This commit is contained in:
61
Docs/configure-git.md
Normal file
61
Docs/configure-git.md
Normal file
@ -0,0 +1,61 @@
|
||||
# PowerShell Script: configure-git.ps1
|
||||
```powershell
|
||||
configure-git.ps1 [<full-name>] [<email-address>] [<favorite-editor>]
|
||||
```
|
||||
|
||||
Sets up the Git user configuration
|
||||
|
||||
## Syntax & Parameters
|
||||
```powershell
|
||||
/home/markus/Repos/PowerShell/Scripts/configure-git.ps1 [[-FullName] <String>] [[-EmailAddress] <String>] [[-FavoriteEditor] <String>] [<CommonParameters>]
|
||||
```
|
||||
|
||||
```
|
||||
-FullName <String>
|
||||
|
||||
Required? false
|
||||
Position? 1
|
||||
Default value
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
```
|
||||
|
||||
```
|
||||
-EmailAddress <String>
|
||||
|
||||
Required? false
|
||||
Position? 2
|
||||
Default value
|
||||
Accept pipeline input? false
|
||||
Accept wildcard characters? false
|
||||
```
|
||||
|
||||
```
|
||||
-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.
|
||||
```
|
||||
|
||||
## Example
|
||||
```powershell
|
||||
PS>./configure-git
|
||||
```
|
||||
|
||||
|
||||
## Notes
|
||||
Author: Markus Fleschutz · License: CC0
|
||||
|
||||
## Related Links
|
||||
https://github.com/fleschutz/PowerShell
|
||||
|
||||
*Generated by convert-ps2md.ps1 using the comment-based help of configure-git.ps1*
|
Reference in New Issue
Block a user