PowerDir.GetPowerDir

0.3.3

PowerDir.dll-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-PowerDir</command:name>
      <command:verb>Get</command:verb>
      <command:noun>PowerDir</command:noun>
      <maml:description>
        <maml:para>An alternative Get-ChildItem.</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>Get-PowerDir is used to display files and directories. Search for them in a user-friendly way and supporting colors.</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>Get-PowerDir</maml:name>
        <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>Path to search. Accepting wildcards (default: *)</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
          <dev:type>
            <maml:name>String</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>*</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>About</maml:name>
          <maml:description>
            <maml:para>About GetPowerDir information</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="d">
          <maml:name>Display</maml:name>
          <maml:description>
            <maml:para>Display type (default: Object)</maml:para>
          </maml:description>
          <command:parameterValueGroup>
            <command:parameterValue required="false" command:variableLength="false">o</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">Object</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">List</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">l</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">ListDetails</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">ld</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">Wide</command:parameterValue>
            <command:parameterValue required="false" command:variableLength="false">w</command:parameterValue>
          </command:parameterValueGroup>
          <command:parameterValue required="true" variableLength="false">DisplayOptions</command:parameterValue>
          <dev:type>
            <maml:name>DisplayOptions</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>Object</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="l">
          <maml:name>Level</maml:name>
          <maml:description>
            <maml:para>Max Recursion Depth (default: int.MaxValue)</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
          <dev:type>
            <maml:name>Int32</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>int.MaxValue</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n">
          <maml:name>NoColor</maml:name>
          <maml:description>
            <maml:para>Disable colors (default: no)</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="r">
          <maml:name>Recursive</maml:name>
          <maml:description>
            <maml:para>Search Recursively (default: No)</maml:para>
          </maml:description>
          <dev:type>
            <maml:name>SwitchParameter</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>False</dev:defaultValue>
        </command:parameter>
      </command:syntaxItem>
    </command:syntax>
    <command:parameters>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>About</maml:name>
        <maml:description>
          <maml:para>About GetPowerDir information</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="d">
        <maml:name>Display</maml:name>
        <maml:description>
          <maml:para>Display type (default: Object)</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">DisplayOptions</command:parameterValue>
        <dev:type>
          <maml:name>DisplayOptions</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>Object</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="l">
        <maml:name>Level</maml:name>
        <maml:description>
          <maml:para>Max Recursion Depth (default: int.MaxValue)</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue>
        <dev:type>
          <maml:name>Int32</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>int.MaxValue</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="n">
        <maml:name>NoColor</maml:name>
        <maml:description>
          <maml:para>Disable colors (default: no)</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="true" pipelineInput="False" position="0" aliases="none">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>Path to search. Accepting wildcards (default: *)</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">String</command:parameterValue>
        <dev:type>
          <maml:name>String</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>*</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="r">
        <maml:name>Recursive</maml:name>
        <maml:description>
          <maml:para>Search Recursively (default: No)</maml:para>
        </maml:description>
        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
        <dev:type>
          <maml:name>SwitchParameter</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>False</dev:defaultValue>
      </command:parameter>
    </command:parameters>
    <command:inputTypes>
      <command:inputType>
        <dev:type>
          <maml:name>None</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>PowerDir.GetPowerDirInfo</maml:name>
        </dev:type>
        <maml:description>
          <maml:para></maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para></maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- Example 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; d</dev:code>
        <dev:remarks>
          <maml:para>get all items in the current path folder.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; d -d l</dev:code>
        <dev:remarks>
          <maml:para>get all items as list in the current path folder.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 3 --------------------------</maml:title>
        <dev:code>PS C:\&gt; d -d dl</dev:code>
        <dev:remarks>
          <maml:para>get all items as detailed list in the current path folder.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 4 --------------------------</maml:title>
        <dev:code>PS C:\&gt; d -d w</dev:code>
        <dev:remarks>
          <maml:para>get all items in a wide 4 columns table in the current path folder.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 5 --------------------------</maml:title>
        <dev:code>PS C:\&gt; d -r -l 2 *.exe</dev:code>
        <dev:remarks>
          <maml:para>get all items ending with `.exe` recursively with a depth level of 2.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 6 --------------------------</maml:title>
        <dev:code>PS C:\&gt; Get-PowerDir | ft</dev:code>
        <dev:remarks>
          <maml:para>get all items in the current directory in `Format-table` mode.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 7 --------------------------</maml:title>
        <dev:code>PS C:\&gt; d \`$RecycleBin</dev:code>
        <dev:remarks>
          <maml:para>Display content in the Recycle Bin in Windows System. Must use the backtick char before `$`to escape it.</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- Example 8 --------------------------</maml:title>
        <dev:code>PS C:\&gt; notepad $Profile
 
function dd() { Get-PowerDir -d ld @args }
function dw() { Get-PowerDir -d w @args }
function l() { Get-PowerDir -d l @args }</dev:code>
        <dev:remarks>
          <maml:para>Edit your profile and add the following aliases</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks />
  </command:command>
</helpItems>