PowerShell Help

Kui tekib sageli vajadus konsulteerida PowerShelli spikriga, siis muutub ruttu tüütavaks spikri väljakutsumine käsurealt.  Kui seda pidevalt vaja on, siis tuleks lahti hoida kahte konsooliakent: ühe peal tööd teha ja teise peal spikrit lugeda.

Teine võimalus oleks kasutada Powershell ISE abi.  Piisab sellest, kui aknas viia tekstikursor käsu peale ja vajutada klahvi <F1>, ning kohe avaneb spikker eraldi aknas.  Tegelikult saab sama teha ka käsurealt:

#Requires -Version 3

Get-Help Get-Help -ShowWindow

Käsk Get-Help oskab avada ka veebipõhist spikrit.  Selleks pole vaja muud, kui küsida abi järgmisel viisil:

#Requires -Version 2

Get-Help Get-Help -Online

Selle peale avaneb veebilehitseja spikri veebiversiooniga tingimusel, et spikker sisaldab sektsioonis Related Links esimese viitena veebiaadressi või on lisatud eraldi.  Seda kontrollib järgnev käsk:

(Get-Help Get-Help).relatedLinks.navigationLink

Või kui spikker puudub, siis võib veebilink olla lisatud käsu enda külge.  Ning loomulikult saab sedasi veebilinki lisada ka oma skriptidesse:

#Requires -Version 3

function New-Calendar {
    [CmdletBinding(SupportsShouldProcess=$true,
    HelpURI=&quot;http://go.microsoft.com/fwlink/?LinkID=01122&quot;)]
 ...
}

(Get-Command New-Calendar).HelpUri
Get-Help New-Calendar -Online

Täpsemalt saab lugeda MSDN-ist.

Sellisel viisil ei saa avada spikri about-teemasid.  Põhjus on selles, et about-teemad on tavalised tekstifailid ja seal ei ole eraldi veebiaadressi ega ka sektsioone, millest veebilinki otsida.

Powershell 3-l on veel ka sisse ehitatud käsk Show-Command, aga see võimaldab juba graafilises liideses käsurea parameetreid sisestada/kasutada.  Samas visualiseerib see käsurea parameetreid ning võimaldab käsu võimalustega rohkem tutvuda.

Powershell 3 ja värskema puhul tasub veel ka seda teada, et neil on vaikimisi spikker kaasa panemata jäänud.  Seda peamiselt selle pärast, et spikri võib käsuga Update-Help õigel hetkel alla tõmmata/uuendada.  Ja siis saab juba täiesti värsket spikrit kasutada.  Tuleb vaid mäletada, et suurem osa Windowsiga kaasa tulnud moodulitest on Windowsi kaustas ja seetõttu peab Update-Help käima süsteemiülema õigustes.

Ning juhul, kui Sa ikka veel kasutada Powershell 2.0 versiooni, siis tuleb leppida  PowerShell (2.0) .CHM spikriga või kasutada PowerShelli kommuuni poolt kirjutatud rakendusi:

  • PowerShell SE – mitte ainult sprikri näitaja. Autor ise ütleb, et: PowerShell ISE Editing Control + PowerShell Help Reader + Cool stuff = PowerShell SE. Õnnetuseks otsustas arendaja parematele jahimaadele minna.
  • Windows PowerShell Cmdlet Help Viewer – WPF rakendus, mis loeb Powershelli spikri .XML faile ja näitab neid loetavas vormingus.
  • Sapien Powershell Help Viewer – tasuta utiliit, mis loeb/interpreteerib Powershelli .XML spikrifaile ja about-dokumente.