Skip to content

Commit

Permalink
update help
Browse files Browse the repository at this point in the history
  • Loading branch information
devblackops committed May 29, 2024
1 parent 08310bd commit 0097adf
Show file tree
Hide file tree
Showing 16 changed files with 280 additions and 26 deletions.
21 changes: 19 additions & 2 deletions docs/en-US/Add-TerminalIconsColorTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ Add a Terminal-Icons color theme for the current user.

### Path (Default)
```
Add-TerminalIconsColorTheme [-Path] <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-TerminalIconsColorTheme [-Path] <String[]> [-Force] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

### LiteralPath
```
Add-TerminalIconsColorTheme [-LiteralPath] <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-TerminalIconsColorTheme [-LiteralPath] <String[]> [-Force] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -122,6 +124,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
21 changes: 19 additions & 2 deletions docs/en-US/Add-TerminalIconsIconTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,14 @@ Add a Terminal-Icons icon theme for the current user.

### Path (Default)
```
Add-TerminalIconsIconTheme [-Path] <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-TerminalIconsIconTheme [-Path] <String[]> [-Force] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

### LiteralPath
```
Add-TerminalIconsIconTheme [-LiteralPath] <String[]> [-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
Add-TerminalIconsIconTheme [-LiteralPath] <String[]> [-Force] [-ProgressAction <ActionPreference>] [-WhatIf]
[-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -122,6 +124,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
18 changes: 17 additions & 1 deletion docs/en-US/Format-TerminalIcons.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Prepend a custom icon (with color) to the provided file or folder object when di
## SYNTAX

```
Format-TerminalIcons [-FileInfo] <FileSystemInfo> [[-CurrentSettings] <Hashtable>] [<CommonParameters>]
Format-TerminalIcons [-FileInfo] <FileSystemInfo> [[-CurrentSettings] <Hashtable>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -68,6 +69,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
18 changes: 17 additions & 1 deletion docs/en-US/Format-TerminalIconsDate.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ schema: 2.0.0
## SYNTAX

```
Format-TerminalIconsDate [[-DateTime] <DateTime>] [[-CurrentSettings] <Hashtable>] [<CommonParameters>]
Format-TerminalIconsDate [[-DateTime] <DateTime>] [[-CurrentSettings] <Hashtable>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -60,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
17 changes: 16 additions & 1 deletion docs/en-US/Format-TerminalIconsFileLength.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ schema: 2.0.0

```
Format-TerminalIconsFileLength [[-FileInfo] <FileSystemInfo>] [[-CurrentSettings] <Hashtable>]
[<CommonParameters>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -61,6 +61,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
18 changes: 17 additions & 1 deletion docs/en-US/Get-TerminalIconsColorTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ List the available color themes.
## SYNTAX

```
Get-TerminalIconsColorTheme [[-CurrentSettings] <Hashtable>] [<CommonParameters>]
Get-TerminalIconsColorTheme [[-CurrentSettings] <Hashtable>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -45,6 +46,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
17 changes: 16 additions & 1 deletion docs/en-US/Get-TerminalIconsGlyphs.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Gets the list of glyphs known to Terminal-Icons.
## SYNTAX

```
Get-TerminalIconsGlyphs [[-Glyphs] <Hashtable>] [<CommonParameters>]
Get-TerminalIconsGlyphs [[-Glyphs] <Hashtable>] [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -46,6 +46,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
18 changes: 17 additions & 1 deletion docs/en-US/Get-TerminalIconsIconTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ List the available icon themes.
## SYNTAX

```
Get-TerminalIconsIconTheme [[-CurrentSettings] <Hashtable>] [<CommonParameters>]
Get-TerminalIconsIconTheme [[-CurrentSettings] <Hashtable>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -45,6 +46,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
17 changes: 16 additions & 1 deletion docs/en-US/Get-TerminalIconsPreference.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Gets the current preferences for Terminal-Icons.
## SYNTAX

```
Get-TerminalIconsPreference [<CommonParameters>]
Get-TerminalIconsPreference [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

## DESCRIPTION
Expand All @@ -30,6 +30,21 @@ PS C:\> {{ Add example code here }}

## PARAMETERS

### -ProgressAction
{{ Fill ProgressAction Description }}

```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
18 changes: 17 additions & 1 deletion docs/en-US/Get-TerminalIconsTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@ Get the currently applied color and icon theme.
## SYNTAX

```
Get-TerminalIconsTheme [[-CurrentSettings] <Hashtable>] [<CommonParameters>]
Get-TerminalIconsTheme [[-CurrentSettings] <Hashtable>] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -45,6 +46,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
20 changes: 18 additions & 2 deletions docs/en-US/Invoke-TerminalIconsThemeMigration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,13 @@ Used to migrate your terminal icon themes to Nerd Fonts v3.

### Path
```
Invoke-TerminalIconsThemeMigration [-Path] <String[]> [<CommonParameters>]
Invoke-TerminalIconsThemeMigration [-Path] <String[]> [-ProgressAction <ActionPreference>] [<CommonParameters>]
```

### LiteralPath
```
Invoke-TerminalIconsThemeMigration [-LiteralPath] <String[]> [<CommonParameters>]
Invoke-TerminalIconsThemeMigration [-LiteralPath] <String[]> [-ProgressAction <ActionPreference>]
[<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -66,6 +67,21 @@ Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
17 changes: 16 additions & 1 deletion docs/en-US/Remove-TerminalIconsTheme.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Removes a color or icon theme

```
Remove-TerminalIconsTheme [[-IconTheme] <String>] [[-ColorTheme] <String>] [[-CurrentSettings] <Hashtable>]
[-Force] [-WhatIf] [-Confirm] [<CommonParameters>]
[-Force] [-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
```

## DESCRIPTION
Expand Down Expand Up @@ -129,6 +129,21 @@ Accept pipeline input: False
Accept wildcard characters: False
```
### -ProgressAction
{{ Fill ProgressAction Description }}
```yaml
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
```
### CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
Expand Down
Loading

0 comments on commit 0097adf

Please sign in to comment.