Een opdracht detecteren met behulp van het Help-systeem

  • 1 minuut

Met behulp van het ingebouwde Help-systeem in PowerShell vindt u meer informatie over een specifieke opdracht. U gebruikt de Get-Command cmdlet om een opdracht te vinden die u nodig hebt. Nadat u de opdracht hebt gevonden, wilt u misschien meer weten over wat de opdracht doet en op verschillende manieren om deze aan te roepen.

Cmdlets detecteren met behulp van het Help-systeem en Get-Help

U kunt de Get-Help kern-cmdlet gebruiken voor meer informatie over een opdracht. Normaal gesproken roept Get-Help u deze aan door deze op naam op te geven en de -Name vlag toe te voegen die de naam bevat van de cmdlet waarover u meer wilt weten. Hier volgt een voorbeeld:

Get-Help -Name Get-Help

Help bijwerken

Nieuwe versies van PowerShell bevatten het Help-systeem niet standaard. De eerste keer dat u uitvoert Get-Help, wordt u gevraagd om de Help-bestanden te installeren. U kunt de Update-Help cmdlet ook uitvoeren om de Help-bestanden te installeren. Omdat een aanroep om veel Help-bestanden te Update-Help downloaden, kan de opdracht standaard slechts één keer per dag worden opgehaald. U kunt dit ophaalgedrag overschrijven met behulp van de -Force vlag.

U werkt de Help-bestanden anders bij in Windows in vergelijking met Linux of macOS. Het proces verschilt omdat wanneer u de Update-Help cmdlet uitvoert, help-bestanden via internet worden opgehaald door de cultuur van uw computer te vergelijken. In Windows is al een cultuur geïnstalleerd, maar deze ontbreekt in Linux en macOS. U moet dus een cultuur opgeven wanneer u Help-bestanden in Linux en macOS bijwerkt.

Hier volgt een voorbeeldopdracht:

Update-Help -UICulture en-US -Verbose

Met deze opdracht geeft u de -UICulture vlag op. Het geeft het de waarde en-US, waarmee Us English Help-bestanden worden opgehaald. Als u uw Help-bestanden in macOS of Linux wilt bijwerken, gebruikt u een cultuur die overeenkomt met de cultuur van uw computer.

Help-secties verkennen

Wanneer u een cmdlet aanroept Get-Help , wordt er een Help-pagina geretourneerd. De pagina bevat veel secties. Deze algemene secties worden waarschijnlijk weergegeven:

  • NAME: Geeft de naam van de opdracht op.
  • SYNTAXIS: Hier ziet u manieren om de opdracht aan te roepen met behulp van een combinatie van vlaggen en soms toegestane parameters.
  • ALIASSEN: een lijst met aliassen voor een opdracht. Een alias is een andere naam voor een opdracht en kan worden gebruikt om de opdracht aan te roepen.
  • OPMERKINGEN: Bevat informatie over de opdrachten die moeten worden uitgevoerd om meer hulp te krijgen voor deze opdracht.
  • PARAMETERS: Bevat details over de parameter. Het bevat het type, een langere beschrijving en acceptabele waarden, indien van toepassing.

Het Help-antwoord filteren

Als u de volledige Help-pagina niet wilt weergeven, beperkt u het antwoord door vlaggen toe te voegen aan uw Get-Help opdracht. Hier volgen enkele vlaggen die u kunt gebruiken:

  • Volledig: retourneert een gedetailleerde Help-pagina. Hiermee geeft u informatie op zoals parameters, invoer en uitvoer die u niet in het standaardantwoord krijgt.
  • Gedetailleerd: Retourneert een antwoord dat lijkt op het standaardantwoord, maar bevat een sectie voor parameters.
  • Voorbeelden: retourneert alleen voorbeelden, indien aanwezig.
  • Online: Hiermee opent u een webpagina voor uw opdracht.
  • Parameter: Vereist een parameternaam als argument. Er worden de eigenschappen van een specifieke parameter weergegeven.

U kunt bijvoorbeeld de volgende opdracht gebruiken om alleen de sectie Voorbeelden van de Help-pagina te retourneren.

Get-Help Get-FileHash -Examples

De leeservaring verbeteren

Als u deze functie uitvoert Get-Help , wordt de volledige Help-pagina geretourneerd. De pagina biedt mogelijk niet de beste leeservaring. Mogelijk moet u schuiven om de sectie te vinden die u wilt lezen. Een betere benadering is het gebruik van de help alias. De help alias verwijst Get-Help naar een functie die ervoor zorgt dat uw uitvoer regel voor regel leesbaar is. Het maakt het antwoord ook leesbaar op pagina, door de uitvoer te pagineren. U gebruikt de help alias in de volgende les.