en-US/PowerBOFH-help.xml

<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh">
  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
    <command:details>
      <command:name>Get-Excuse</command:name>
      <command:verb>Get</command:verb>
      <command:noun>Excuse</command:noun>
      <maml:description>
        <maml:para>Generates an excuse.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>This cmdlet will generate a BOFH-style excuse for you to use at work.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-Excuse</maml:name>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
          <maml:name>Timeout</maml:name>
          <maml:Description>
            <maml:para>Wait this many milliseconds before giving up and printing a generic excuse. If not specified, the default value is thirty seconds. A value of zero will cause this cmdlet to wait forever.</maml:para>
          </maml:Description>
          <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
          <dev:type>
            <maml:name>UInt32</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>30000</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">
        <maml:name>Timeout</maml:name>
        <maml:Description>
          <maml:para>Wait this many milliseconds before giving up and printing a generic excuse. If not specified, the default value is thirty seconds. A value of zero will cause this cmdlet to wait forever.</maml:para>
        </maml:Description>
        <command:parameterValue required="true" variableLength="false">UInt32</command:parameterValue>
        <dev:type>
          <maml:name>UInt32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>30000</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>This cmdlet accepts no input.</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>String</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>An excuse will be printed to the output stream.</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>This module requires Internet connectivity.</maml:para>
        <maml:para>This module was developed without BOFH server operator Jeff Ballard, and is not affiliated with him in any way, shape, or form.</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-Excuse</dev:code>
        <dev:remarks>
          <maml:para>Downloads an excuse from the BOFH server.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-Excuse -Timeout 10000</dev:code>
        <dev:remarks>
          <maml:para>Downloads an excuse from the BOFH server, giving up after ten seconds.</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>https://github.com/rhymeswithmogul/PowerBOFH/blob/main/man/Get-Excuse_en-US.md</maml:uri>
      </maml:navigationLink>
      <maml:navigationLink>
        <maml:linkText>Jeff Ballard's BOFH-Style Excuse Server:</maml:linkText>
        <maml:uri>http://pages.cs.wisc.edu/~ballard/bofh/</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>