v2.33.0

Author: jdhitsolutions

PSScriptToolsManual.pdf

@@ -2,7 +2,11 @@
 
 [![PSGallery Version](https://img.shields.io/powershellgallery/v/PSScripttools.png?style=for-the-badge&logo=powershell&label=PowerShell%20Gallery)](https://www.powershellgallery.com/packages/PSScripttools/) [![PSGallery Downloads](https://img.shields.io/powershellgallery/dt/PSScripttools.png?style=for-the-badge&label=Downloads)](https://www.powershellgallery.com/packages/PSScripttools/)
 
-This module contains a collection of functions, variables and format files that you can use to enhance your PowerShell scripting work, or get more done from a PowerShell prompt with less typing. Most of the commands are designed to work cross-platform. Please post any questions, problems, or feedback in [Issues](https://github.com/jdhitsolutions/PSScriptTools/issues). Any feedback is greatly appreciated.
+## Abstract
+
+This module contains a collection of functions, variables, and format files that you can use to enhance your PowerShell scripting work, or get more done from a PowerShell prompt with less typing. Most of the commands are designed to work cross-platform. Please post any questions, problems, or feedback at [Issues](https://github.com/jdhitsolutions/PSScriptTools/issues). Any feedback is greatly appreciated.
+
+The contents of this file and other documentation can be viewed using the `Open-PSScriptToolsHelp` command. You can also use `Get-PSScriptTools` to see a summary of module commands.
 
 *Please note that code samples have been formatted to fit an 80 character width. Some example code breaks lines without using line continuation characters. I'm trusting that you can figure out how to run the example.*
 
@@ -41,9 +45,7 @@ Starting in v2.2.0, the module was restructured to better support `Desktop` and
 
 It is recommended to install this module from the PowerShell Gallery and not GitHub.
 
-### Uninstall the Module
-
-To remove the module from your system you can uninstall it.
+To remove the module from your system you can easily uninstall it with common PowerShell commands.
 
 ```powershell
 Get-Module PSScriptTools | Remove-Module
@@ -1181,7 +1183,7 @@ Handles  NPM(K)    PM(K)      WS(K)     CPU(s)     Id  SI ProcessName
     118       8     1580       7476       0.02  35668   0 svchost
 ```
 
-These custom Select commands are not necessarily designed for peformance and there may be better ways to achieve the same results from these examples.
+These custom Select commands are not necessarily designed for performance and there may be better ways to achieve the same results from these examples.
 
 ## Time Functions
 
@@ -1373,7 +1375,7 @@ Expect a period of trial and error to find a good font that works with your text
 
 This command is intended for writers and those who need to document with PowerShell. You can pipe any command to this function and you will get the regular output in your PowerShell session.Simultaneously a copy of the output will be sent to the Windows clipboard. The copied output will include a prompt constructed from the current location unless you use the CommandOnly parameter.
 
-You can run this a command like this:
+You can run a command like this:
 
 ```powershell
 Get-Process | Sort WS -Descending | Select -first 5 | Out-Copy
@@ -2177,4 +2179,4 @@ If you find this module useful, you might also want to look at my PowerShell too
 
 Where possible these commands have been tested with PowerShell 7, but not every platform. If you encounter problems, have suggestions or other feedback, please post an [issue](https://github.com/jdhitsolutions/PSScriptTools/issues). It is assumed you will __not__ be running these commands on any edition of PowerShell Core or any beta releases of PowerShell 7.
 
-Last Updated *2020-11-04 22:51:29Z*
+Last Updated *2020-11-09 21:23:07Z*

README.md

@@ -21,7 +21,7 @@ ConvertTo-Markdown [[-Inputobject] <Object>] [-Title <String>]
 
 ## DESCRIPTION
 
-This command is designed to accept pipelined output and create a markdown document. The pipeline output will formatted as a text block or you can specify a table. You can optionally define a title, content to appear before the output and content to appear after the output.
+This command is designed to accept pipelined output and create a generic markdown document. The pipeline output will formatted as a text block or you can specify a table. You can optionally define a title, content to appear before the output, and content to appear after the output. Best efforts have been made to produce markdown output that meets basic standards.
 
 The command does not create a text file. You need to pipe results from this command to a cmdlet like Out-File or Set-Content. See examples.
 
@@ -56,7 +56,7 @@ Convertto-Markdown -title "Service Check" -precontent "## $($env:computername)"`
 -postcontent "_report $(Get-Date)_" | Out-File c:\work\svc.md
 ```
 
-Re-run the previous command and save output to a file.
+Re-run the previous command and save the output to a file.
 
 ### EXAMPLE 3
 
@@ -84,7 +84,7 @@ PS C:\>$out += ConvertTo-Markdown -PostContent $footer
 PS C:\>$out | Set-Content c:\work\report.md
 ```
 
-Here is an example that create a series of markdown fragments for each computer and at the end creates a markdown document.
+Here is an example that creates a series of markdown fragments for each computer and in the end creates a markdown document.
 
 ## PARAMETERS
 
@@ -106,7 +106,7 @@ Accept wildcard characters: False
 
 ### -Title
 
-Specify a top level title. You do not need to include any markdown.
+Specify a top-level title. You do not need to include any markdown.
 
 ```yaml
 Type: String

docs/ConvertTo-Markdown.md

@@ -60,7 +60,7 @@ Get all of the System counters with Get-Counter and pipe them to Get-MyCounter.
 ### Example 2
 
 ```powershell
-PS C:\> Get-MyCounter -computername server18| Format-table -view category
+PS C:\> Get-MyCounter -computername server18 | Format-table -view category
 
 
    Category: network interface(intel[r] ethernet connection [11] i219-lm)
@@ -196,13 +196,13 @@ Gets data from the specified performance counters. Enter one or more counter pat
 
  Each counter path has the following format:
 
-"[\\<ComputerName>]\<CounterSet>(<Instance>)\<CounterName>"
+\\\\ComputerName\\CounterSet(Instance)\\CounterName
 
 For example:
 
-"\\Server01\Processor(2)\% User Time"
+\\\\Server01\\Processor(2)\\% User Time
 
-The <ComputerName> element is optional. If you omit it, Get-MyCounter uses the value of the ComputerName parameter.
+The ComputerName element is optional. If you omit it, Get-MyCounter uses the value of the ComputerName parameter.
 
 ```yaml
 Type: String[]

docs/Get-MyCounter.md

@@ -19,7 +19,7 @@ Open-PSScriptToolsHelp [<CommonParameters>]
 
 ## DESCRIPTION
 
-This command will launch a PDF manual for all commands in the PSScriptTools module. It is assumed you have a default application for PDF files.
+This command will launch a PDF manual for all commands in the PSScriptTools module. It is assumed you have a default application associated with PDF files.
 
 ## EXAMPLES
 

docs/Open-PSScriptToolsHelp.md

@@ -20,28 +20,24 @@ Out-Copy [-InputObject] <Object> [-Width <Int32>] [-CommandOnly]
 
 ## DESCRIPTION
 
-This command is intended for writers and those who need to document with PowerShell.
-You can pipe any command to this function and you will get the regular output in your PowerShell session.
-Simultaneously a copy of the output will be sent to the Windows clipboard.
-The copied output will include a prompt constructed from the current location unless you use the CommandOnly parameter.
+This command is intended for writers and those who need to document with PowerShell. You can pipe any command to this function and you will get the regular output in your PowerShell session. Simultaneously, a copy of the output will be sent to the Windows clipboard. The copied output will include a prompt constructed from the current location unless you use the CommandOnly parameter.
 
-NOTE: You can only capture what is written to the Success pipeline.
-This command will not copy any other streams such as Verbose, Warning, or Error.
+NOTE: You can only capture what is written to the Success pipeline. This command will not copy any other streams such as Verbose, Warning, or Error.
 
 ## EXAMPLES
 
 ### EXAMPLE 1
 
 ```powershell
-PS C:\> Get-Process | Sort WS -Descending | Select -first 5 | Out-Copy
+PS C:\> Get-Process | Sort WS -Descending | Select-First 5 | Out-Copy
 ```
 
 This will execute your expression and write the output to the pipeline.
 The output plus the command:
 
 PS C:\\> Get-Process | Sort WS -Descending | Select -first 5
 
-will be copied to the clipboard.
+will be copied to the clipboard. This example is using the Select-First function from the PSScriptTools module.
 
 ### EXAMPLE 2
 

docs/Out-Copy.md

@@ -19,7 +19,7 @@ Out-More [-InputObject] <Object[]> [[-Count] <Int32>] [-ClearScreen]
 
 ## DESCRIPTION
 
-This function is designed to display groups or "pages" of objects to the PowerShell pipeline. It is modeled after the legacy More.com command line utility. By default the command will write out objects out to the pipeline in groups of 50. You will be prompted after each grouping.
+This function is designed to display groups or "pages" of objects to the PowerShell pipeline. It is modeled after the legacy More.com command-line utility. By default, the command will write objects out to the pipeline in groups of 50. You will be prompted after each grouping.
 
 Pressing M or Enter will get the next group. Pressing A will stop paging and display all of the remaining objects. Pressing N will display the next object. Press Q to stop writing anything else to the pipeline.
 
@@ -73,7 +73,7 @@ Accept wildcard characters: False
 
 ### -Count
 
-The number of objects to group together in a page.
+The number of objects to group as a page.
 
 ```yaml
 Type: Int32
@@ -89,7 +89,7 @@ Accept wildcard characters: False
 
 ### -ClearScreen
 
-Clear the screen prior to writing data to the pipeline.
+Clear the screen before writing data to the pipeline.
 
 ```yaml
 Type: SwitchParameter

docs/Out-More.md

@@ -35,7 +35,7 @@ Write-Detail [[-Message] <String>] [-Prefix <String>] [-Date]
 
 ## DESCRIPTION
 
-This command is designed to be used within your functions and scripts to make it easier to write a detailed message that you can use as verbose output. The assumption is that you are using an advanced function with a Begin, Process and End scriptblocks. You can create a detailed message to indicate what part of the code is being executed. The output can include a full time stamp, or a time string which includes a millisecond value.
+This command is designed to be used within your functions and scripts to make it easier to write a detailed message that you can use as verbose output. The assumption is that you are using an advanced function with Begin, Process and End scriptblocks. You can create a detailed message to indicate what part of the code is being executed. The output can include a full-time stamp, or a time string which includes a millisecond value.
 
 In a script you might use it like this in a Begin block:
 

docs/Write-Detail.md

@@ -2445,7 +2445,7 @@ Thursday, March 14, 2019 4:00:00 PM</dev:code>
       </maml:description>
     </command:details>
     <maml:description>
-      <maml:para>This command is designed to accept pipelined output and create a markdown document. The pipeline output will formatted as a text block or you can specify a table. You can optionally define a title, content to appear before the output and content to appear after the output.</maml:para>
+      <maml:para>This command is designed to accept pipelined output and create a generic markdown document. The pipeline output will formatted as a text block or you can specify a table. You can optionally define a title, content to appear before the output, and content to appear after the output. Best efforts have been made to produce markdown output that meets basic standards.</maml:para>
       <maml:para>The command does not create a text file. You need to pipe results from this command to a cmdlet like Out-File or Set-Content. See examples.</maml:para>
     </maml:description>
     <command:syntax>
@@ -2466,7 +2466,7 @@ Thursday, March 14, 2019 4:00:00 PM</dev:code>
         <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
           <maml:name>Title</maml:name>
           <maml:Description>
-            <maml:para>Specify a top level title. You do not need to include any markdown.</maml:para>
+            <maml:para>Specify a top-level title. You do not need to include any markdown.</maml:para>
           </maml:Description>
           <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
           <dev:type>
@@ -2540,7 +2540,7 @@ Thursday, March 14, 2019 4:00:00 PM</dev:code>
       <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
         <maml:name>Title</maml:name>
         <maml:Description>
-          <maml:para>Specify a top level title. You do not need to include any markdown.</maml:para>
+          <maml:para>Specify a top-level title. You do not need to include any markdown.</maml:para>
         </maml:Description>
         <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
         <dev:type>
@@ -2650,7 +2650,7 @@ Running  Winrm              Windows Remote Management (WS-Manag...
 Convertto-Markdown -title "Service Check" -precontent "## $($env:computername)"`
 -postcontent "_report $(Get-Date)_" | Out-File c:\work\svc.md</dev:code>
         <dev:remarks>
-          <maml:para>Re-run the previous command and save output to a file.</maml:para>
+          <maml:para>Re-run the previous command and save the output to a file.</maml:para>
         </dev:remarks>
       </command:example>
       <command:example>
@@ -2677,7 +2677,7 @@ ConvertTo-Markdown -PreContent "## $($computer.toUpper())"
 PS C:\&gt;$out += ConvertTo-Markdown -PostContent $footer
 PS C:\&gt;$out | Set-Content c:\work\report.md</dev:code>
         <dev:remarks>
-          <maml:para>Here is an example that create a series of markdown fragments for each computer and at the end creates a markdown document.</maml:para>
+          <maml:para>Here is an example that creates a series of markdown fragments for each computer and in the end creates a markdown document.</maml:para>
         </dev:remarks>
       </command:example>
     </command:examples>
@@ -6111,10 +6111,10 @@ np   notepad       ReadOnly</dev:code>
           <maml:Description>
             <maml:para>Gets data from the specified performance counters. Enter one or more counter paths. Wildcards are permitted only in the Instance value. You can also pipe counter path strings to Get-MyCounter.</maml:para>
             <maml:para> Each counter path has the following format:</maml:para>
-            <maml:para>"[\&lt;ComputerName&gt;]&lt;CounterSet&gt;(&lt;Instance&gt;)&lt;CounterName&gt;"</maml:para>
+            <maml:para>\\ComputerName\CounterSet(Instance)\CounterName</maml:para>
             <maml:para>For example:</maml:para>
-            <maml:para>"\Server01\Processor(2)\% User Time"</maml:para>
-            <maml:para>The &lt;ComputerName&gt; element is optional. If you omit it, Get-MyCounter uses the value of the ComputerName parameter.</maml:para>
+            <maml:para>\\Server01\Processor(2)\% User Time</maml:para>
+            <maml:para>The ComputerName element is optional. If you omit it, Get-MyCounter uses the value of the ComputerName parameter.</maml:para>
           </maml:Description>
           <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
           <dev:type>
@@ -6202,10 +6202,10 @@ np   notepad       ReadOnly</dev:code>
         <maml:Description>
           <maml:para>Gets data from the specified performance counters. Enter one or more counter paths. Wildcards are permitted only in the Instance value. You can also pipe counter path strings to Get-MyCounter.</maml:para>
           <maml:para> Each counter path has the following format:</maml:para>
-          <maml:para>"[\&lt;ComputerName&gt;]&lt;CounterSet&gt;(&lt;Instance&gt;)&lt;CounterName&gt;"</maml:para>
+          <maml:para>\\ComputerName\CounterSet(Instance)\CounterName</maml:para>
           <maml:para>For example:</maml:para>
-          <maml:para>"\Server01\Processor(2)\% User Time"</maml:para>
-          <maml:para>The &lt;ComputerName&gt; element is optional. If you omit it, Get-MyCounter uses the value of the ComputerName parameter.</maml:para>
+          <maml:para>\\Server01\Processor(2)\% User Time</maml:para>
+          <maml:para>The ComputerName element is optional. If you omit it, Get-MyCounter uses the value of the ComputerName parameter.</maml:para>
         </maml:Description>
         <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue>
         <dev:type>
@@ -6296,7 +6296,7 @@ Timestamp             Category Counter                           Value
       </command:example>
       <command:example>
         <maml:title>-------------------------- Example 2 --------------------------</maml:title>
-        <dev:code>PS C:\&gt; Get-MyCounter -computername server18| Format-table -view category
+        <dev:code>PS C:\&gt; Get-MyCounter -computername server18 | Format-table -view category
 
 
    Category: network interface(intel[r] ethernet connection [11] i219-lm)
@@ -11932,7 +11932,7 @@ Out-Copy -commandonly</dev:code>
       </maml:description>
     </command:details>
     <maml:description>
-      <maml:para>This function is designed to display groups or "pages" of objects to the PowerShell pipeline. It is modeled after the legacy More.com command line utility. By default the command will write out objects out to the pipeline in groups of 50. You will be prompted after each grouping.</maml:para>
+      <maml:para>This function is designed to display groups or "pages" of objects to the PowerShell pipeline. It is modeled after the legacy More.com command-line utility. By default, the command will write objects out to the pipeline in groups of 50. You will be prompted after each grouping.</maml:para>
       <maml:para>Pressing M or Enter will get the next group. Pressing A will stop paging and display all of the remaining objects. Pressing N will display the next object. Press Q to stop writing anything else to the pipeline.</maml:para>
       <maml:para>Note that you may encounter an error message when quitting prematurely, especially on non-Windows platforms. You can ignore these errors.</maml:para>
     </maml:description>
@@ -16311,7 +16311,7 @@ PS C:\&gt; Invoke-Command -scriptblock $sb</dev:code>
       </maml:description>
     </command:details>
     <maml:description>
-      <maml:para>This command is designed to be used within your functions and scripts to make it easier to write a detailed message that you can use as verbose output. The assumption is that you are using an advanced function with a Begin, Process and End scriptblocks. You can create a detailed message to indicate what part of the code is being executed. The output can include a full time stamp, or a time string which includes a millisecond value.</maml:para>
+      <maml:para>This command is designed to be used within your functions and scripts to make it easier to write a detailed message that you can use as verbose output. The assumption is that you are using an advanced function with Begin, Process and End scriptblocks. You can create a detailed message to indicate what part of the code is being executed. The output can include a full-time stamp, or a time string which includes a millisecond value.</maml:para>
       <maml:para>In a script you might use it like this in a Begin block:</maml:para>
       <maml:para>    $pfx = "BEGIN"</maml:para>
       <maml:para>    Write-Detail "Starting $($MyInvocation.MyCommand)" -Prefix $pfx | Write-Verbose</maml:para>