Sixel

0.2.0

en-US/Sixel.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>ConvertTo-Sixel</command:name>
      <command:verb>ConvertTo</command:verb>
      <command:noun>Sixel</command:noun>
      <maml:description>
        <maml:para>Converts an image to sixel
</maml:para>
      </maml:description>
    </command:details>
    <maml:description>
      <maml:para>The `ConvertTo-Sixel` takes an image and converts it to sixel
</maml:para>
    </maml:description>
    <command:syntax>
      <command:syntaxItem>
        <maml:name>ConvertTo-Sixel</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="FullName">
          <maml:name>Path</maml:name>
          <maml:description>
            <maml:para>A path to a local image to convert to sixel.
</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>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="None">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in the image.
Max is 256.
</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
          <dev:type>
            <maml:name>int</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>256</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="CellWidth">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.
</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
          <dev:type>
            <maml:name>int</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>PixelWidth</maml:name>
          <maml:description>
            <maml:para>Width of the image in Pixels, the height will be scaled to maintain aspect ratio
</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
          <dev:type>
            <maml:name>int</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.
</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:syntaxItem>
        <maml:name>ConvertTo-Sixel</maml:name>
        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True" position="named" aliases="Uri">
          <maml:name>Url</maml:name>
          <maml:description>
            <maml:para>A URL of the image to download and convert to sixel.
</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>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="None">
          <maml:name>MaxColors</maml:name>
          <maml:description>
            <maml:para>The maximum number of colors to use in the image.
Max is 256.
</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
          <dev:type>
            <maml:name>int</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>256</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="CellWidth">
          <maml:name>Width</maml:name>
          <maml:description>
            <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.
</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
          <dev:type>
            <maml:name>int</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>PixelWidth</maml:name>
          <maml:description>
            <maml:para>Width of the image in Pixels, the height will be scaled to maintain aspect ratio
</maml:para>
          </maml:description>
          <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
          <dev:type>
            <maml:name>int</maml:name>
            <maml:uri />
          </dev:type>
          <dev:defaultValue>None</dev:defaultValue>
        </command:parameter>
        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
          <maml:name>Force</maml:name>
          <maml:description>
            <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.
</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="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="0" aliases="FullName">
        <maml:name>Path</maml:name>
        <maml:description>
          <maml:para>A path to a local image to convert to sixel.
</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>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True" position="named" aliases="Uri">
        <maml:name>Url</maml:name>
        <maml:description>
          <maml:para>A URL of the image to download and convert to sixel.
</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>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="None">
        <maml:name>MaxColors</maml:name>
        <maml:description>
          <maml:para>The maximum number of colors to use in the image.
Max is 256.
</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
        <dev:type>
          <maml:name>int</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>256</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="CellWidth">
        <maml:name>Width</maml:name>
        <maml:description>
          <maml:para>Width of the image in character cells, the height will be scaled to maintain aspect ratio.
</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
        <dev:type>
          <maml:name>int</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>PixelWidth</maml:name>
        <maml:description>
          <maml:para>Width of the image in Pixels, the height will be scaled to maintain aspect ratio
</maml:para>
        </maml:description>
        <command:parameterValue required="true" variableLength="false">int</command:parameterValue>
        <dev:type>
          <maml:name>int</maml:name>
          <maml:uri />
        </dev:type>
        <dev:defaultValue>None</dev:defaultValue>
      </command:parameter>
      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">
        <maml:name>Force</maml:name>
        <maml:description>
          <maml:para>Force the command to attempt to output sixel data even if the terminal does not support sixel.
</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>System.String</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>Path or url to an image file
</maml:para>
        </maml:description>
      </command:inputType>
    </command:inputTypes>
    <command:returnValues>
      <command:returnValue>
        <dev:type>
          <maml:name>System.String</maml:name>
        </dev:type>
        <maml:description>
          <maml:para>a sixel string
</maml:para>
        </maml:description>
      </command:returnValue>
    </command:returnValues>
    <maml:alertSet>
      <maml:alert>
        <maml:para>This will only work if your terminal supports sixel images.
Windows Terminal Preview version 1.22.2702.0 or newer
</maml:para>
      </maml:alert>
    </maml:alertSet>
    <command:examples>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 1 --------------------------</maml:title>
        <dev:code>PS C:\&gt; ConvertTo-Sixel -Url 'https://imgs.xkcd.com/comics/git_commit.png'</dev:code>
        <dev:remarks>
          <maml:para>Converts the xkcd to sixel
</maml:para>
        </dev:remarks>
      </command:example>
      <command:example>
        <maml:title>-------------------------- EXAMPLE 2 --------------------------</maml:title>
        <dev:code>PS C:\&gt; ConvertTo-Sixel -Path C:\files\smiley.png</dev:code>
        <dev:remarks>
          <maml:para>Converts a local file to sixel format
</maml:para>
        </dev:remarks>
      </command:example>
    </command:examples>
    <command:relatedLinks>
      <maml:navigationLink>
        <maml:linkText>Online Version:</maml:linkText>
        <maml:uri>https://github.com/trackd/Sixel/blob/main/docs/en-US/ConvertTo-Sixel.md</maml:uri>
      </maml:navigationLink>
    </command:relatedLinks>
  </command:command>
</helpItems>