"Fossies" - the Fresh Open Source Software Archive

Member "PowerShell-7.2.6/assets/default.help.txt" (11 Aug 2022, 3312 Bytes) of package /linux/misc/PowerShell-7.2.6.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file.

    1 
    2 TOPIC
    3     PowerShell Help System
    4 
    5 SHORT DESCRIPTION
    6     Displays help about PowerShell cmdlets and concepts.
    7 
    8 LONG DESCRIPTION
    9     PowerShell Help describes PowerShell cmdlets, functions, scripts, and
   10     modules, and explains concepts, including the elements of the PowerShell
   11     language.
   12 
   13     PowerShell does not include help files, but you can read the help topics
   14     online, or use the Update-Help cmdlet to download help files to your
   15     computer and then use the Get-Help cmdlet to display the help topics at
   16     the command line.
   17 
   18     You can also use the Update-Help cmdlet to download updated help files
   19     as they are released so that your local help content is never obsolete.
   20 
   21     Without help files, Get-Help displays auto-generated help for cmdlets,
   22     functions, and scripts.
   23 
   24 
   25   ONLINE HELP
   26     You can find help for PowerShell online at
   27     https://go.microsoft.com/fwlink/?LinkID=108518.
   28 
   29     To open online help for any cmdlet or function, type:
   30 
   31         Get-Help <cmdlet-name> -Online
   32 
   33   UPDATE-HELP
   34     To download and install help files on your computer:
   35 
   36        1. Start PowerShell with the "Run as administrator" option.
   37        2. Type:
   38 
   39           Update-Help
   40 
   41     After the help files are installed, you can use the Get-Help cmdlet to
   42     display the help topics. You can also use the Update-Help cmdlet to
   43     download updated help files so that your local help files are always
   44     up-to-date.
   45 
   46     For more information about the Update-Help cmdlet, type:
   47 
   48        Get-Help Update-Help -Online
   49 
   50     or go to: https://go.microsoft.com/fwlink/?LinkID=210614
   51 
   52 
   53   GET-HELP
   54     The Get-Help cmdlet displays help at the command line from content in
   55     help files on your computer. Without help files, Get-Help displays basic
   56     help about cmdlets and functions. You can also use Get-Help to display
   57     online help for cmdlets and functions.
   58 
   59     To get help for a cmdlet, type:
   60 
   61         Get-Help <cmdlet-name>
   62 
   63     To get online help, type:
   64 
   65         Get-Help <cmdlet-name> -Online
   66 
   67     The titles of conceptual topics begin with "About_". To get help for a
   68     concept or language element, type:
   69 
   70         Get-Help About_<topic-name>
   71 
   72     To search for a word or phrase in all help files, type:
   73 
   74         Get-Help <search-term>
   75 
   76     For more information about the Get-Help cmdlet, type:
   77 
   78         Get-Help Get-Help -Online
   79 
   80     or go to: https://go.microsoft.com/fwlink/?LinkID=113316
   81 
   82 
   83   EXAMPLES:
   84       Save-Help              : Download help files from the internet and save
   85                                them on a file share.
   86 
   87       Update-Help            : Downloads and installs help files from the
   88                                internet or a file share.
   89 
   90       Get-Help Get-Process   : Displays help about the Get-Process cmdlet.
   91 
   92       Get-Help Get-Process -Online
   93                              : Opens online help for the Get-Process cmdlet.
   94 
   95       Help Get-Process       : Displays help about Get-Process one page at a
   96                                time.
   97       Get-Process -?         : Displays help about the Get-Process cmdlet.
   98 
   99       Get-Help About_Modules : Displays help about PowerShell modules.
  100 
  101       Get-Help remoting      : Searches the help topics for the word "remoting."
  102 
  103   SEE ALSO:
  104       about_Updatable_Help
  105       Get-Help
  106       Save-Help
  107       Update-Help
  108