Skip to content

Update -Option section in New-Alias.md #2161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 2, 2018
Merged

Update -Option section in New-Alias.md #2161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 11 additions & 10 deletions reference/3.0/Microsoft.PowerShell.Utility/New-Alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,26 +91,27 @@ Accept wildcard characters: False
```

### -Option
Sets the value of the Options property of the alias.

Specifies the value of the **Options** property of the alias.
Valid values are:

- None: Sets no options. ("None" is the default.)
- ReadOnly: Can be deleted. Cannot be not changed, except by using the Force parameter.
- Constant: Cannot be deleted or changed.
- Private: The alias is available only in the current scope.
- AllScope: The alias is copied to any new scopes that are created.
- None: The alias has no constraints (default value)
- ReadOnly: The alias can be deleted but cannot be changed except by using the **Force** parameter
- Constant: The alias cannot be deleted or changed
- Private: The alias is available only in the current scope
- AllScope: The alias is copied to any new scopes that are created
- Unspecified: The option is not specified

To see the Options property of all aliases in the session, type "get-alias | format-table -property name, options -autosize".
To see the **Options** property of all aliases in the session, type `Get-Alias | Format-Table -Property Name, Options -AutoSize`.

```yaml
Type: ScopedItemOptions
Parameter Sets: (All)
Aliases:
Aliases:
Accepted values: None, ReadOnly, Constant, Private, AllScope, Unspecified

Required: False
Position: Named
Default value: "None"
Default value: [System.Management.Automation.ScopedItemOptions]::None
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
21 changes: 11 additions & 10 deletions reference/4.0/Microsoft.PowerShell.Utility/New-Alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,26 +96,27 @@ Accept wildcard characters: False
```

### -Option
Sets the value of the Options property of the alias.

Specifies the value of the **Options** property of the alias.
Valid values are:

- None: Sets no options. ("None" is the default.)
- ReadOnly: Can be deleted. Cannot be not changed, except by using the Force parameter.
- Constant: Cannot be deleted or changed.
- Private: The alias is available only in the current scope.
- AllScope: The alias is copied to any new scopes that are created.
- None: The alias has no constraints (default value)
- ReadOnly: The alias can be deleted but cannot be changed except by using the **Force** parameter
- Constant: The alias cannot be deleted or changed
- Private: The alias is available only in the current scope
- AllScope: The alias is copied to any new scopes that are created
- Unspecified: The option is not specified

To see the Options property of all aliases in the session, type "get-alias | format-table -property name, options -autosize".
To see the **Options** property of all aliases in the session, type `Get-Alias | Format-Table -Property Name, Options -AutoSize`.

```yaml
Type: ScopedItemOptions
Parameter Sets: (All)
Aliases:
Aliases:
Accepted values: None, ReadOnly, Constant, Private, AllScope, Unspecified

Required: False
Position: Named
Default value: "None"
Default value: [System.Management.Automation.ScopedItemOptions]::None
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
30 changes: 12 additions & 18 deletions reference/5.0/Microsoft.PowerShell.Utility/New-Alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,33 +111,27 @@ Accept wildcard characters: False
```

### -Option
Specifies that the cmdlet sets the value of the **Options** property of the alias.
The acceptable values for this parameter are:
Specifies the value of the **Options** property of the alias.
Valid values are:

- None: The alias has no constraints (default value)
- ReadOnly: The alias can be deleted but cannot be changed except by using the **Force** parameter
- Constant: The alias cannot be deleted or changed
- Private: The alias is available only in the current scope
- AllScope: The alias is copied to any new scopes that are created
- Unspecified: The option is not specified

- None.
Sets no options.
(None is the default.)
- ReadOnly.
Can be deleted.
Cannot be not changed, except by using the *Force* parameter.
- Constant.
Cannot be deleted or changed.
- Private.
The alias is available only in the current scope.
- AllScope.
The alias is copied to any new scopes that are created.

To see the Options property of all aliases in the session, type `Get-Alias | Format-Table -Property name, options -autosize`.
To see the **Options** property of all aliases in the session, type `Get-Alias | Format-Table -Property Name, Options -AutoSize`.

```yaml
Type: ScopedItemOptions
Parameter Sets: (All)
Aliases:
Aliases:
Accepted values: None, ReadOnly, Constant, Private, AllScope, Unspecified

Required: False
Position: Named
Default value: None
Default value: [System.Management.Automation.ScopedItemOptions]::None
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
30 changes: 12 additions & 18 deletions reference/5.1/Microsoft.PowerShell.Utility/New-Alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,33 +111,27 @@ Accept wildcard characters: False
```

### -Option
Specifies that the cmdlet sets the value of the **Options** property of the alias.
The acceptable values for this parameter are:
Specifies the value of the **Options** property of the alias.
Valid values are:

- None: The alias has no constraints (default value)
- ReadOnly: The alias can be deleted but cannot be changed except by using the **Force** parameter
- Constant: The alias cannot be deleted or changed
- Private: The alias is available only in the current scope
- AllScope: The alias is copied to any new scopes that are created
- Unspecified: The option is not specified

- None.
Sets no options.
(None is the default.)
- ReadOnly.
Can be deleted.
Cannot be not changed, except by using the *Force* parameter.
- Constant.
Cannot be deleted or changed.
- Private.
The alias is available only in the current scope.
- AllScope.
The alias is copied to any new scopes that are created.

To see the **Options****** property of all aliases in the session, type `Get-Alias | Format-Table -Property name, options -autosize`.
To see the **Options** property of all aliases in the session, type `Get-Alias | Format-Table -Property Name, Options -AutoSize`.

```yaml
Type: ScopedItemOptions
Parameter Sets: (All)
Aliases:
Aliases:
Accepted values: None, ReadOnly, Constant, Private, AllScope, Unspecified

Required: False
Position: Named
Default value: None
Default value: [System.Management.Automation.ScopedItemOptions]::None
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down
28 changes: 11 additions & 17 deletions reference/6/Microsoft.PowerShell.Utility/New-Alias.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,23 +96,17 @@ Accept wildcard characters: False
```

### -Option
Specifies that the cmdlet sets the value of the **Options** property of the alias.
The acceptable values for this parameter are:
Specifies the value of the **Options** property of the alias.
Valid values are:

- None: The alias has no constraints (default value)
- ReadOnly: The alias can be deleted but cannot be changed except by using the **Force** parameter
- Constant: The alias cannot be deleted or changed
- Private: The alias is available only in the current scope
- AllScope: The alias is copied to any new scopes that are created
- Unspecified: The option is not specified

- None.
Sets no options.
(None is the default.)
- ReadOnly.
Can be deleted.
Cannot be not changed, except by using the *Force* parameter.
- Constant.
Cannot be deleted or changed.
- Private.
The alias is available only in the current scope.
- AllScope.
The alias is copied to any new scopes that are created.

To see the **Options****** property of all aliases in the session, type `Get-Alias | Format-Table -Property name, options -autosize`.
To see the **Options** property of all aliases in the session, type `Get-Alias | Format-Table -Property Name, Options -AutoSize`.

```yaml
Type: ScopedItemOptions
Expand All @@ -122,7 +116,7 @@ Accepted values: None, ReadOnly, Constant, Private, AllScope, Unspecified

Required: False
Position: Named
Default value: None
Default value: [System.Management.Automation.ScopedItemOptions]::None
Accept pipeline input: False
Accept wildcard characters: False
```
Expand Down