File wofftools.xml of Package wofftools

Overview Repositories Revisions Requests Users Attributes Meta

File wofftools.xml of Package wofftools

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
                         "http://www.docbook.org/xml/4.5/docbookx.dtd">
<refentry lang="en" id="woff-tools">
  <refentryinfo>
    <productname>wofftools</productname>
    <authorgroup>
      <corpauthor>TypeSupply</corpauthor>
      
      <author>
        <firstname>Thomas</firstname>
        <surname>Schraitle</surname>
        <contrib>Collected information for Manpage</contrib>
      </author>
    </authorgroup>
  </refentryinfo>
  <refmeta>
    <refentrytitle>wofftools</refentrytitle>
    <manvolnum>1</manvolnum>
    <refmiscinfo class="version">@VERSION@</refmiscinfo>
    <refmiscinfo class="source">http://code.typesupply.com/wiki/woffTools</refmiscinfo>
    <refmiscinfo class="manual">n/a</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>wofftools</refname>
    <refpurpose>Tools for Manipulating WOFF Files</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <title>Synopsis</title>
    <cmdsynopsis>
      <command>woff-css</command>
      <arg choice="opt">options</arg>
      <arg choice="plain">fontpath1</arg>
      <arg choice="plain">fontpath2</arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>woff-info</command>
      <arg choice="opt">options</arg>
      <arg choice="plain">fontpath1</arg>
      <arg choice="plain">fontpath2</arg>      
    </cmdsynopsis>
    <cmdsynopsis>
      <command>woff-proof</command>
      <arg choice="opt">options</arg>
      <arg choice="plain">fontpath1</arg>
      <arg choice="plain">fontpath2</arg>      
    </cmdsynopsis>
    <cmdsynopsis>
      <command>woff-validate</command>
      <arg choice="opt">options</arg>
      <arg choice="plain">fontpath1</arg>
      <arg choice="plain">fontpath2</arg>      
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id="woff-css">
    <title>woff-css</title>
    <para>This tool examines the contents of a WOFF file and attempts to
      generate a CSS @font-face rule based on the data found in the WOFF
      file. The results of this tool should always be carefully
      checked.</para>
    <variablelist>
      <title>Options</title>
      <varlistentry>
        <term><option>--version</option></term>
        <listitem>
          <para>show program's version number and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>show this help message and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option> <replaceable>OUTPUTDIRECTORY</replaceable></term>
        <listitem>
          <para>Output directory. The default is to output the CSS into
            the same directory as the font file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o</option> <replaceable>OUTPUTFILENAME</replaceable></term>
        <listitem>
          <para>Output file name. The default is "fontfilename.css". If
            this file already exists a time stamp will be added to the
            file name.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l</option></term>
        <listitem>
          <para>Write "local" instructions as part of the "src"
            descriptor.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="woff-info">
    <title>woff-info</title>
    <para>This tool displays information about the contents of one or more WOFF files.</para>
    <variablelist>
      <title>Options</title>
      <varlistentry>
        <term><option>--version</option></term>
        <listitem>
          <para>show program's version number and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>show this help message and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option> <replaceable>OUTPUTDIRECTORY</replaceable></term>
        <listitem>
          <para>Output directory. The default is to output the report
            into the same directory as the font file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o</option> <replaceable>OUTPUTFILENAME</replaceable></term>
        <listitem>
          <para>Output file name. The default is
              <filename>fontfilename_info.html</filename>.</para>
        </listitem>
      </varlistentry>
    </variablelist>    
  </refsect1>
  <refsect1 id="woff-proof">
    <title>woff-proof</title>
    <para>This tool displays information about the contents of one or more WOFF files.</para>
     <variablelist>
      <title>Options</title>
      <varlistentry>
        <term><option>--version</option></term>
        <listitem>
          <para>show program's version number and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>show this help message and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option> <replaceable>OUTPUTDIRECTORY</replaceable></term>
        <listitem>
          <para>Output directory. The default is to output the proof
                      into the same directory as the font file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o</option> <replaceable>OUTPUTFILENAME</replaceable></term>
        <listitem>
          <para>Output file name. The default is
              <filename>fontfilename_proof.html</filename>.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option> <replaceable>SAMPLETEXTFILE</replaceable></term>
        <listitem>
          <para>Sample text file. A file containing sample text to
            display. If not file is provided, <literal>The quick brown
              fox...</literal> will be used.</para>
        </listitem>
      </varlistentry>  
    </variablelist>
  </refsect1>
  <refsect1 id="woff-validate">
    <title>woff-validate</title>
    <para>This tool examines the structure of one or more WOFF files and
      issues a detailed report about the validity of the file structure.
      It does not validate the wrapped font data.</para>
         <variablelist>
      <title>Options</title>
      <varlistentry>
        <term><option>--version</option></term>
        <listitem>
          <para>show program's version number and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>show this help message and exit</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d</option> <replaceable>OUTPUTDIRECTORY</replaceable></term>
        <listitem>
          <para>Output directory. The default is to output the report
            into the same directory as the font file.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-o</option> <replaceable>OUTPUTFILENAME</replaceable></term>
        <listitem>
          <para>Output file name. The default is
              <filename>fontfilename_validate.html</filename>.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
</refentry>

Places

File wofftools.xml of Package wofftools

Places