PowerShell-HelpFile-Bug/output-2.txt at main · GeeLaw/PowerShell-HelpFile-Bug · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
NAME
    Get-Help

SYNOPSIS
    Displays information about PowerShell commands and concepts.


SYNTAX
    Get-Help [-Category <System.String[]>] [-Component <System.String[]>] [-Full <System.Management.Automation.SwitchParameter>]
    [-Functionality <System.String[]>] [[-Name] <System.String>] [-Path <System.String>] [-Role <System.String[]>] [<CommonParameters>]

    Get-Help [-Category <System.String[]>] [-Component <System.String[]>] -Detailed <System.Management.Automation.SwitchParameter>
    [-Functionality <System.String[]>] [[-Name] <System.String>] [-Path <System.String>] [-Role <System.String[]>] [<CommonParameters>]

    Get-Help [-Category <System.String[]>] [-Component <System.String[]>] [-Functionality <System.String[]>] [[-Name] <System.String>] [-Path
    <System.String>] [-Role <System.String[]>] [<CommonParameters>]

    Get-Help [-Category <System.String[]>] [-Component <System.String[]>] [-Functionality <System.String[]>] [[-Name] <System.String>] [-Path
    <System.String>] [-Role <System.String[]>] [<CommonParameters>]

    Get-Help [-Category <System.String[]>] [-Component <System.String[]>] [-Functionality <System.String[]>] [[-Name] <System.String>] -Online
    <System.Management.Automation.SwitchParameter> [-Path <System.String>] [-Role <System.String[]>] [<CommonParameters>]

    Get-Help [-Category <System.String[]>] [-Component <System.String[]>] [-Functionality <System.String[]>] [[-Name] <System.String>] [-Path
    <System.String>] [-Role <System.String[]>] -ShowWindow <System.Management.Automation.SwitchParameter> [<CommonParameters>]


DESCRIPTION
    The `Get-Help` cmdlet displays information about PowerShell concepts and commands, including cmdlets, functions, Common Information Model
    (CIM) commands, workflows, providers, aliases, and scripts.

    To get help for a PowerShell cmdlet, type `Get-Help` followed by the cmdlet name, such as: `Get-Help Get-Process`.

    Conceptual help articles in PowerShell begin with **about_**, such as **about_Comparison_Operators**. To see all **about_** articles, type
    `Get-Help about_*`. To see a particular article, type `Get-Help about_<article-name>`, such as `Get-Help about_Comparison_Operators`.

    To get help for a PowerShell provider, type `Get-Help` followed by the provider name. For example, to get help for the Certificate
    provider, type `Get-Help Certificate`.

    You can also type `help` or `man`, which displays one screen of text at a time. Or, `<cmdlet-name> -?`, that's identical to `Get-Help`, but
    only works for cmdlets.

    `Get-Help` gets the help content that it displays from help files on your computer. Without the help files, `Get-Help` displays only basic
    information about cmdlets. Some PowerShell modules include help files. Beginning in PowerShell 3.0, the modules that come with the Windows
    operating system don't include help files. To download or update the help files for a module in PowerShell 3.0, use the `Update-Help`
    cmdlet.

    You can also view the PowerShell help documents online. To get the online version of a help file, use the **Online** parameter, such as:
    `Get-Help Get-Process -Online`.

    If you type `Get-Help` followed by the exact name of a help article, or by a word unique to a help article, `Get-Help` displays the
    article's content. If you specify the exact name of a command alias, `Get-Help` displays the help for the original command. If you enter a
    word or word pattern that appears in several help article titles, `Get-Help` displays a list of the matching titles. If you enter any text
    that doesn't appear in any help article titles, `Get-Help` displays a list of articles that include that text in their contents.

    `Get-Help` can get help articles for all supported languages and locales. `Get-Help` first looks for help files in the locale set for
    Windows, then in the parent locale, such as **pt** for **pt-BR**, and then in a fallback locale. Beginning in PowerShell 3.0, if `Get-Help`
    doesn't find help in the fallback locale, it looks for help articles in English, **en-US**, before it returns an error message or
    displaying autogenerated help.

    For information about the symbols that `Get-Help` displays in the command syntax diagram, see
    [about_Command_Syntax](About/about_Command_Syntax.md). For information about parameter attributes, such as **Required** and **Position**,
    see [about_Parameters](About/about_Parameters.md).

    > [!NOTE] > In PowerShell 3.0 and PowerShell 4.0, `Get-Help` can't find **About** articles in modules unless > the module is imported into
    the current session. To get **About** articles in a module, import the > module using the `Import-Module` cmdlet or by running a cmdlet
    that's included in the module.

    Beginning with **PSReadLine** v2.2.2, the module ships with two functions that provide quick access to help while you are typing a command
    on the command line. The help is displayed in the terminal in an alternate screen buffer with paging.

    When you hit the <kbd>F1</kbd> key, the **PSReadLine** `ShowCommandHelp` function invokes `Get-Help -Full` for the cmdlet name closest to
    the left of the cursor. When the cursor is immediately to the left of a parameter, the function jumps to that parameter's description in
    the full help topic. When you hit <kbd>Q</kbd> to exit the help view, you are returned to the command line at the same cursor position so
    you can continue typing the command.

    When you use the key combination <kbd>Alt</kbd>+<kbd>h</kbd>, the **PSReadLine** `ShowParameterHelp` function displays help information for
    the parameter immediately to the left of the cursor. The help text is displayed below the command line. This allows you to see the
    description of the parameter and continue typing your command.

    For more information, see [Using dynamic help](/powershell/scripting/learn/shell/dynamic-help).


RELATED LINKS
    Online Version https://learn.microsoft.com/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.5&WT.mc_id=ps-gethelp
    about_Command_Syntax About/about_Command_Syntax.md
    about_Comment_Based_Help About/about_Comment_Based_Help.md
    Get-Command Get-Command.md
    Supporting Updatable Help /powershell/scripting/developer/module/supporting-updatable-help
    Update-Help Update-Help.md
    Writing Comment-Based Help Topics /powershell/scripting/developer/help/writing-comment-based-help-topics
    Writing Help for PowerShell Cmdlets /powershell/scripting/developer/help/writing-help-for-windows-powershell-cmdlets

REMARKS
    To see the examples, type: "Get-Help Get-Help -Examples"
    For more information, type: "Get-Help Get-Help -Detailed"
    For technical information, type: "Get-Help Get-Help -Full"
    For online help, type: "Get-Help Get-Help -Online"