gramps/gramps2/doc/gramps-manual/C/cmdplug.xml

<sect1 id="cmdplug-id0">
  <title>Detailed plugin option reference</title>
  <sect2 id="cmdplug-reps">
    <title>Reports</title>
<sect3 id="cmdplug-id1">
  <title>Common Options</title>
    <variablelist>
        <varlistentry>
          <term><command>style</command>: =name</term>
          <listitem>
            <para>Style name.</para>
          <itemizedlist>
      <listitem><para>default</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>pagebbg</command>: =0/1</term>
          <listitem>
            <para>Page break between generations.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>off</command>: =format</term>
          <listitem>
            <para>Output file format.</para>
          <itemizedlist>
      <listitem><para>print</para></listitem>
      <listitem><para>sxw</para></listitem>
      <listitem><para>ps</para></listitem>
      <listitem><para>pdf</para></listitem>
      <listitem><para>svg</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>of</command>: =filename</term>
          <listitem>
            <para>Output file name. MANDATORY</para>
            <para>Value: <userinput>/home/shura/whatever_name</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>papero</command>: =num</term>
          <listitem>
            <para>Paper orientation number.</para>
          <itemizedlist>
      <listitem><para>0	Portrait</para></listitem>
      <listitem><para>1	Landscape</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>gen</command>: =num</term>
          <listitem>
            <para>Number of generations to follow.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>filter</command>: =num</term>
          <listitem>
            <para>Filter number.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>template</command>: =name</term>
          <listitem>
            <para>Template name (HTML only).</para>
            <para>Value: <userinput>/home/shura/whatever_name</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>papers</command>: =name</term>
          <listitem>
            <para>Paper size name.</para>
          <itemizedlist>
      <listitem><para>Letter</para></listitem>
      <listitem><para>Legal</para></listitem>
      <listitem><para>A0</para></listitem>
      <listitem><para>A1</para></listitem>
      <listitem><para>A2</para></listitem>
      <listitem><para>A3</para></listitem>
      <listitem><para>A4</para></listitem>
      <listitem><para>A5</para></listitem>
      <listitem><para>B0</para></listitem>
      <listitem><para>B1</para></listitem>
      <listitem><para>B2</para></listitem>
      <listitem><para>B3</para></listitem>
      <listitem><para>B4</para></listitem>
      <listitem><para>B5</para></listitem>
      <listitem><para>B6</para></listitem>
      <listitem><para>B</para></listitem>
      <listitem><para>C</para></listitem>
      <listitem><para>D</para></listitem>
      <listitem><para>E</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>dispf</command>: =str</term>
          <listitem>
            <para>Display format for the outputbox.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>id</command>: =ID</term>
          <listitem>
            <para>Gramps ID of a central person. MANDATORY</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id2">
  <title>Ancestor Chart</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>ancestor_chart</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id3">
  <title>Ancestor Chart (Wall Chart)</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>ancestor_chart2</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>singlep</command>: =0/1</term>
          <listitem>
            <para>Whether to scale to fit on a single page.</para>
          <orderedlist>
      <listitem><para>Do not scale to fit</para></listitem>
      <listitem><para>Scale to fit</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>compress</command>: =0/1</term>
          <listitem>
            <para>Whether to compress chart.</para>
          <orderedlist>
      <listitem><para>Do not compress chart</para></listitem>
      <listitem><para>Compress chart</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>title</command>: =str</term>
          <listitem>
            <para>Title string for the report</para>
            <para>Value: <userinput>Whatever String You Wish</userinput></para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id4">
  <title>Ahnentafel Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>ancestor_report</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id5">
  <title>Comprehensive Ancestors Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>ancestors_report</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>cites</command>: =0/1</term>
          <listitem>
            <para>Whether to cite sources.</para>
          <orderedlist>
      <listitem><para>Do not cite sources</para></listitem>
      <listitem><para>Cite sources</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id6">
  <title>Descendant Graph</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>descendant_graph</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id7">
  <title>Descendant Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>descend_report</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id8">
  <title>Detailed Ancestral Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>det_ancestor_report</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>repdate</command>: =0/1</term>
          <listitem>
            <para>Whether to replace missing Dates with blanks.</para>
          <orderedlist>
      <listitem><para>Do not replace missing Dates</para></listitem>
      <listitem><para>Replace missing Dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incsources</command>: =0/1</term>
          <listitem>
            <para>Whether to include source references.</para>
          <orderedlist>
      <listitem><para>Do not include sources</para></listitem>
      <listitem><para>Include sources</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incphotos</command>: =0/1</term>
          <listitem>
            <para>Whether to include images.</para>
          <orderedlist>
      <listitem><para>Do not include images</para></listitem>
      <listitem><para>Include images</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>desref</command>: =0/1</term>
          <listitem>
            <para>Whether to add descendant references in child list.</para>
          <orderedlist>
      <listitem><para>Do not add references</para></listitem>
      <listitem><para>Add references</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>computeage</command>: =0/1</term>
          <listitem>
            <para>Whether to compute age.</para>
          <orderedlist>
      <listitem><para>Do not compute age</para></listitem>
      <listitem><para>Compute age</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>fulldates</command>: =0/1</term>
          <listitem>
            <para>Whether to use full dates instead of just year.</para>
          <orderedlist>
      <listitem><para>Do not use full dates</para></listitem>
      <listitem><para>Use full dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incnames</command>: =0/1</term>
          <listitem>
            <para>Whether to include other names.</para>
          <orderedlist>
      <listitem><para>Do not include other names</para></listitem>
      <listitem><para>Include other names</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>listc</command>: =0/1</term>
          <listitem>
            <para>Whether to list children.</para>
          <orderedlist>
      <listitem><para>Do not list children</para></listitem>
      <listitem><para>List children</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incevents</command>: =0/1</term>
          <listitem>
            <para>Whether to include events.</para>
          <orderedlist>
      <listitem><para>Do not include events</para></listitem>
      <listitem><para>Include events</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>usenick</command>: =0/1</term>
          <listitem>
            <para>Whether to use the nick name as the first name.</para>
          <orderedlist>
      <listitem><para>Do not use nick name</para></listitem>
      <listitem><para>Use nick name</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incnotes</command>: =0/1</term>
          <listitem>
            <para>Whether to include notes.</para>
          <orderedlist>
      <listitem><para>Do not include notes</para></listitem>
      <listitem><para>Include notes</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>omitda</command>: =0/1</term>
          <listitem>
            <para>Whether to omit duplicate ancestors.</para>
          <orderedlist>
      <listitem><para>Do not omit duplicates</para></listitem>
      <listitem><para>Omit duplicates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>repplace</command>: =0/1</term>
          <listitem>
            <para>Whether to replace missing Places with blanks.</para>
          <orderedlist>
      <listitem><para>Do not replace missing Places</para></listitem>
      <listitem><para>Replace missing Places</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id9">
  <title>Detailed Descendant Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>det_descendant_report</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>repdate</command>: =0/1</term>
          <listitem>
            <para>Whether to replace missing Dates with blanks.</para>
          <orderedlist>
      <listitem><para>Do not replace missing Dates</para></listitem>
      <listitem><para>Replace missing Dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incsources</command>: =0/1</term>
          <listitem>
            <para>Whether to include source references.</para>
          <orderedlist>
      <listitem><para>Do not include sources</para></listitem>
      <listitem><para>Include sources</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incphotos</command>: =0/1</term>
          <listitem>
            <para>Whether to include images.</para>
          <orderedlist>
      <listitem><para>Do not include images</para></listitem>
      <listitem><para>Include images</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>desref</command>: =0/1</term>
          <listitem>
            <para>Whether to add descendant references in child list.</para>
          <orderedlist>
      <listitem><para>Do not add references</para></listitem>
      <listitem><para>Add references</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>computeage</command>: =0/1</term>
          <listitem>
            <para>Whether to compute age.</para>
          <orderedlist>
      <listitem><para>Do not compute age</para></listitem>
      <listitem><para>Compute age</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>fulldates</command>: =0/1</term>
          <listitem>
            <para>Whether to use full dates instead of just year.</para>
          <orderedlist>
      <listitem><para>Do not use full dates</para></listitem>
      <listitem><para>Use full dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incnames</command>: =0/1</term>
          <listitem>
            <para>Whether to include other names.</para>
          <orderedlist>
      <listitem><para>Do not include other names</para></listitem>
      <listitem><para>Include other names</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>listc</command>: =0/1</term>
          <listitem>
            <para>Whether to list children.</para>
          <orderedlist>
      <listitem><para>Do not list children</para></listitem>
      <listitem><para>List children</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incevents</command>: =0/1</term>
          <listitem>
            <para>Whether to include events.</para>
          <orderedlist>
      <listitem><para>Do not include events</para></listitem>
      <listitem><para>Include events</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>usenick</command>: =0/1</term>
          <listitem>
            <para>Whether to use the nick name as the first name.</para>
          <orderedlist>
      <listitem><para>Do not use nick name</para></listitem>
      <listitem><para>Use nick name</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incnotes</command>: =0/1</term>
          <listitem>
            <para>Whether to include notes.</para>
          <orderedlist>
      <listitem><para>Do not include notes</para></listitem>
      <listitem><para>Include notes</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>omitda</command>: =0/1</term>
          <listitem>
            <para>Whether to omit duplicate ancestors.</para>
          <orderedlist>
      <listitem><para>Do not omit duplicates</para></listitem>
      <listitem><para>Omit duplicates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>repplace</command>: =0/1</term>
          <listitem>
            <para>Whether to replace missing Places with blanks.</para>
          <orderedlist>
      <listitem><para>Do not replace missing Places</para></listitem>
      <listitem><para>Replace missing Places</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id10">
  <title>Family Group Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>family_group</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>spouse_id</command>: =ID</term>
          <listitem>
            <para>Gramps ID of the person's spouse.</para>
            <para>Value: <userinput>Use show=id to get ID list.</userinput></para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id11">
  <title>Fan Chart</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>fan_chart</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id12">
  <title>FTM Style Ancestor Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>ftm_ancestor_report</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id13">
  <title>FTM Style Descendant Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>ftm_descendant_report</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id14">
  <title>Relationship Graph</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>rel_graph</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>rankdir</command>: =str</term>
          <listitem>
            <para>Graph direction.</para>
          <itemizedlist>
      <listitem><para>LR	Horizontal</para></listitem>
      <listitem><para>RL	Vertical</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>justyears</command>: =0/1</term>
          <listitem>
            <para>Whether to use years only.</para>
          <orderedlist>
      <listitem><para>Do not use years only</para></listitem>
      <listitem><para>Use years only</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>latin</command>: =0/1</term>
          <listitem>
            <para>Needs to be set if font doesn't support unicode.</para>
          <orderedlist>
      <listitem><para>Supports unicode</para></listitem>
      <listitem><para>Supports only Latin1</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>arrow</command>: =str</term>
          <listitem>
            <para>Arrow styles for heads and tails.</para>
          <itemizedlist>
      <listitem><para>d	Descendants &lt;- Ancestors</para></listitem>
      <listitem><para>a	Descendants -&gt; Ancestors</para></listitem>
      <listitem><para>da	Descendants &lt;-&gt; Ancestors</para></listitem>
      <listitem><para>	Descendants - Ancestors</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>dashedl</command>: =0/1</term>
          <listitem>
            <para>Whether to use dotted lines for non-birth relationships.</para>
          <orderedlist>
      <listitem><para>Do not use dotted lines</para></listitem>
      <listitem><para>Use dotted lines</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>url</command>: =0/1</term>
          <listitem>
            <para>Whether to include URLs.</para>
          <orderedlist>
      <listitem><para>Do not include URLs</para></listitem>
      <listitem><para>Include URLs</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>pagesh</command>: =num</term>
          <listitem>
            <para>Number of pages in horizontal direction.</para>
            <para>Value: <userinput>Integer values</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>placecause</command>: =0/1</term>
          <listitem>
            <para>Whether to replace missing dates with place/cause.</para>
          <orderedlist>
      <listitem><para>Do not replace blank dates</para></listitem>
      <listitem><para>Replace blank dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>gvof</command>: =str</term>
          <listitem>
            <para>Output format to convert dot file into.</para>
          <itemizedlist>
      <listitem><para>ps	Postscript</para></listitem>
      <listitem><para>svg	Structured Vector Graphics (SVG)</para></listitem>
      <listitem><para>svgz	Compressed Structured Vector Graphics (SVG)</para></listitem>
      <listitem><para>png	PNG image</para></listitem>
      <listitem><para>jpg	JPEG image</para></listitem>
      <listitem><para>gif	GIF image</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>color</command>: =str</term>
          <listitem>
            <para>Whether and how to colorize graph.</para>
          <itemizedlist>
      <listitem><para>outline	B&amp;W Outline</para></listitem>
      <listitem><para>colored	Colored outline</para></listitem>
      <listitem><para>filled	Color fill</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incid</command>: =0/1</term>
          <listitem>
            <para>Whether to include IDs.</para>
          <orderedlist>
      <listitem><para>Do not include IDs</para></listitem>
      <listitem><para>Include IDs</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incdate</command>: =0/1</term>
          <listitem>
            <para>Whether to include dates.</para>
          <orderedlist>
      <listitem><para>Do not include dates</para></listitem>
      <listitem><para>Include dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>pagesv</command>: =num</term>
          <listitem>
            <para>Number of pages in vertical direction.</para>
            <para>Value: <userinput>Integer values</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>font</command>: =str</term>
          <listitem>
            <para>Font to use in the report.</para>
          <itemizedlist>
      <listitem><para>	Default</para></listitem>
      <listitem><para>Helvetica	Postscript / Helvetica</para></listitem>
      <listitem><para>FreeSans	Truetype / FreeSans</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>margin</command>: =num</term>
          <listitem>
            <para>Margin size.</para>
            <para>Value: <userinput>Floating point value, in cm</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>showfamily</command>: =0/1</term>
          <listitem>
            <para>Whether to show family nodes.</para>
          <orderedlist>
      <listitem><para>Do not show family nodes</para></listitem>
      <listitem><para>Show family nodes</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id15">
  <title>Relationship Graph</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>rel_graph2</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>rankdir</command>: =str</term>
          <listitem>
            <para>Graph direction.</para>
          <itemizedlist>
      <listitem><para>LR	Horizontal</para></listitem>
      <listitem><para>RL	Vertical</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>justyears</command>: =0/1</term>
          <listitem>
            <para>Whether to use years only.</para>
          <orderedlist>
      <listitem><para>Do not use years only</para></listitem>
      <listitem><para>Use years only</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>latin</command>: =0/1</term>
          <listitem>
            <para>Needs to be set if font doesn't support unicode.</para>
          <orderedlist>
      <listitem><para>Supports unicode</para></listitem>
      <listitem><para>Supports only Latin1</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>arrow</command>: =str</term>
          <listitem>
            <para>Arrow styles for heads and tails.</para>
          <itemizedlist>
      <listitem><para>d	Descendants &lt;- Ancestors</para></listitem>
      <listitem><para>a	Descendants -&gt; Ancestors</para></listitem>
      <listitem><para>da	Descendants &lt;-&gt; Ancestors</para></listitem>
      <listitem><para>	Descendants - Ancestors</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>dashedl</command>: =0/1</term>
          <listitem>
            <para>Whether to use dotted lines for non-birth relationships.</para>
          <orderedlist>
      <listitem><para>Do not use dotted lines</para></listitem>
      <listitem><para>Use dotted lines</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>url</command>: =0/1</term>
          <listitem>
            <para>Whether to include URLs.</para>
          <orderedlist>
      <listitem><para>Do not include URLs</para></listitem>
      <listitem><para>Include URLs</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>pagesh</command>: =num</term>
          <listitem>
            <para>Number of pages in horizontal direction.</para>
            <para>Value: <userinput>Integer values</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>placecause</command>: =0/1</term>
          <listitem>
            <para>Whether to replace missing dates with place/cause.</para>
          <orderedlist>
      <listitem><para>Do not replace blank dates</para></listitem>
      <listitem><para>Replace blank dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>gvof</command>: =str</term>
          <listitem>
            <para>Output format to convert dot file into.</para>
          <itemizedlist>
      <listitem><para>ps	Postscript</para></listitem>
      <listitem><para>svg	Structured Vector Graphics (SVG)</para></listitem>
      <listitem><para>svgz	Compressed Structured Vector Graphics (SVG)</para></listitem>
      <listitem><para>png	PNG image</para></listitem>
      <listitem><para>jpg	JPEG image</para></listitem>
      <listitem><para>gif	GIF image</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>color</command>: =str</term>
          <listitem>
            <para>Whether and how to colorize graph.</para>
          <itemizedlist>
      <listitem><para>outline	B&amp;W Outline</para></listitem>
      <listitem><para>colored	Colored outline</para></listitem>
      <listitem><para>filled	Color fill</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incid</command>: =0/1</term>
          <listitem>
            <para>Whether to include IDs.</para>
          <orderedlist>
      <listitem><para>Do not include IDs</para></listitem>
      <listitem><para>Include IDs</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>incdate</command>: =0/1</term>
          <listitem>
            <para>Whether to include dates.</para>
          <orderedlist>
      <listitem><para>Do not include dates</para></listitem>
      <listitem><para>Include dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>pagesv</command>: =num</term>
          <listitem>
            <para>Number of pages in vertical direction.</para>
            <para>Value: <userinput>Integer values</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>font</command>: =str</term>
          <listitem>
            <para>Font to use in the report.</para>
          <itemizedlist>
      <listitem><para>	Default</para></listitem>
      <listitem><para>Helvetica	Postscript / Helvetica</para></listitem>
      <listitem><para>FreeSans	Truetype / FreeSans</para></listitem>
          </itemizedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>margin</command>: =num</term>
          <listitem>
            <para>Margin size.</para>
            <para>Value: <userinput>Floating point value, in cm</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>showfamily</command>: =0/1</term>
          <listitem>
            <para>Whether to show family nodes.</para>
          <orderedlist>
      <listitem><para>Do not show family nodes</para></listitem>
      <listitem><para>Show family nodes</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id16">
  <title>Complete Individual Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>indiv_complete</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>cites</command>: =0/1</term>
          <listitem>
            <para>Whether to cite sources.</para>
          <orderedlist>
      <listitem><para>Do not cite sources</para></listitem>
      <listitem><para>Cite sources</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id17">
  <title>Individual Summary</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>individual_summary</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id18">
  <title>Generate Web Site (deprecated)</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>webpage</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLidurl</command>: =str</term>
          <listitem>
            <para>URL for links from GRAMPS IDs</para>
            <para>Value: <userinput>the_url_value</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLext</command>: =str</term>
          <listitem>
            <para>Extension for generated files</para>
            <para>Value: <userinput>Any extension you like: html, htm, php, asp, etc.</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLimagedir</command>: =str</term>
          <listitem>
            <para>Image subdirectory</para>
            <para>Value: <userinput>image_subdir_name</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLsplita</command>: =0/1</term>
          <listitem>
            <para>Split alphabetical sections to different pages</para>
          <orderedlist>
      <listitem><para>Do not split sections</para></listitem>
      <listitem><para>Split sections</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLincpriv</command>: =0/1</term>
          <listitem>
            <para>Inclusion of people marked private</para>
          <orderedlist>
      <listitem><para>Do not include</para></listitem>
      <listitem><para>Include</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLincid</command>: =0/1</term>
          <listitem>
            <para>Include GRAMPS ID in the report</para>
          <orderedlist>
      <listitem><para>Do not include</para></listitem>
      <listitem><para>Include</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLidxcol</command>: =num</term>
          <listitem>
            <para>Number of columns in the index page</para>
            <para>Value: <userinput>Any integer number</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLcmtxtsi</command>: =0/1</term>
          <listitem>
            <para>Inclusion of comments and text in source information</para>
          <orderedlist>
      <listitem><para>Do not include</para></listitem>
      <listitem><para>Include</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLlnktoalphabet</command>: =0/1</term>
          <listitem>
            <para>Include links to alphabetical sections in index page</para>
          <orderedlist>
      <listitem><para>Do not include</para></listitem>
      <listitem><para>Include</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLgendex</command>: =0/1</term>
          <listitem>
            <para>Create a GENDEX index</para>
          <orderedlist>
      <listitem><para>Do not create</para></listitem>
      <listitem><para>Create</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLtreed</command>: =num</term>
          <listitem>
            <para>Depth of ancestor tree</para>
            <para>Value: <userinput>Any integer number</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLidxt</command>: =str</term>
          <listitem>
            <para>Template name for the index page</para>
            <para>Value: <userinput>/full/path/to/the/tpkg</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLlinktidx</command>: =0/1</term>
          <listitem>
            <para>Include links to the index page</para>
          <orderedlist>
      <listitem><para>Do not include</para></listitem>
      <listitem><para>Include</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLrestrictinfo</command>: =0/1</term>
          <listitem>
            <para>Restrict information on living people</para>
          <orderedlist>
      <listitem><para>Do not restrict</para></listitem>
      <listitem><para>Restrict</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLyearso</command>: =0/1</term>
          <listitem>
            <para>Use only birth year on the index page</para>
          <orderedlist>
      <listitem><para>Use full date</para></listitem>
      <listitem><para>Use just year</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLidxbirth</command>: =0/1</term>
          <listitem>
            <para>Append birth dates to the names on the index page</para>
          <orderedlist>
      <listitem><para>Do not append</para></listitem>
      <listitem><para>Append</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLshorttree</command>: =0/1</term>
          <listitem>
            <para>Include short ancestor tree</para>
          <orderedlist>
      <listitem><para>Do not include</para></listitem>
      <listitem><para>Include</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLimg</command>: =num</term>
          <listitem>
            <para>Inclusion of images</para>
          <orderedlist>
      <listitem><para>No images at all</para></listitem>
      <listitem><para>No images for living people</para></listitem>
      <listitem><para>Images for all people</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLod</command>: =str</term>
          <listitem>
            <para>Output directory for the web site</para>
            <para>Value: <userinput>/full/name/of/the/dir</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>HTMLplaceidx</command>: =0/1</term>
          <listitem>
            <para>Create an index of all Places</para>
          <orderedlist>
      <listitem><para>Do not create</para></listitem>
      <listitem><para>Create</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id19">
  <title>Book Report</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>book</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>bookname</command>: =name</term>
          <listitem>
            <para>Name of the book. MANDATORY</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id20">
  <title>Descendant Wall Chart</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>descend_chart2</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>singlep</command>: =0/1</term>
          <listitem>
            <para>Whether to scale to fit on a single page.</para>
          <orderedlist>
      <listitem><para>Do not scale to fit</para></listitem>
      <listitem><para>Scale to fit</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>title</command>: =str</term>
          <listitem>
            <para>Title string for the report</para>
            <para>Value: <userinput>Whatever String You Wish</userinput></para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
  </sect2>
  <sect2 id="cmdplug-tools">
     <title>Tools</title>
<sect3 id="cmdplug-id21">
  <title>Common Options</title>
    <variablelist>
        <varlistentry>
          <term><command>filter</command>: =num</term>
          <listitem>
            <para>Filter number.</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>id</command>: =ID</term>
          <listitem>
            <para>Gramps ID of a central person.</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id22">
  <title>Rename personal event types</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>chtype</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>fromtype</command>: =str</term>
          <listitem>
            <para>Type of events to replace</para>
            <para>Value: <userinput>Event type string</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>totype</command>: =str</term>
          <listitem>
            <para>New type replacing the old one</para>
            <para>Value: <userinput>Event type string</userinput></para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id23">
  <title>Check and repair database</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>check</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id24">
  <title>Reorder GRAMPS IDs</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>reorder_ids</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id25">
  <title>Verify the database</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>verify</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>lngwdw</command>: =num</term>
          <listitem>
            <para>Maximum number of consecutive years of widowhood</para>
            <para>Value: <userinput>Number of years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>mxchildmom</command>: =num</term>
          <listitem>
            <para>Maximum number of children for a woman</para>
            <para>Value: <userinput>Number of children</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>wedder</command>: =num</term>
          <listitem>
            <para>Maximum number of spouses for a person</para>
            <para>Value: <userinput>Number of spouses</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>mxchilddad</command>: =num</term>
          <listitem>
            <para>Maximum  number of children for a man</para>
            <para>Value: <userinput>Number of chidlren</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>estimate_age</command>: =0/1</term>
          <listitem>
            <para>Whether to estimate missing dates</para>
          <orderedlist>
      <listitem><para>Do not estimate</para></listitem>
      <listitem><para>Estimate dates</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>yngmar</command>: =num</term>
          <listitem>
            <para>Minimum age to marry</para>
            <para>Value: <userinput>Age in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>oldmar</command>: =num</term>
          <listitem>
            <para>Maximum age to marry</para>
            <para>Value: <userinput>Age in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>cbspan</command>: =num</term>
          <listitem>
            <para>Maximum span of years for all children</para>
            <para>Value: <userinput>Span in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>oldage</command>: =num</term>
          <listitem>
            <para>Maximum age</para>
            <para>Value: <userinput>Age in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>olddad</command>: =num</term>
          <listitem>
            <para>Maximum age to father a child</para>
            <para>Value: <userinput>Age in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>hwdif</command>: =num</term>
          <listitem>
            <para>Maximum husband-wife age difference</para>
            <para>Value: <userinput>Age difference in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>yngmom</command>: =num</term>
          <listitem>
            <para>Minimum age to bear a child</para>
            <para>Value: <userinput>Age in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>yngdad</command>: =num</term>
          <listitem>
            <para>Minimum age to father a child</para>
            <para>Value: <userinput>Age in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>oldmom</command>: =num</term>
          <listitem>
            <para>Maximum age to bear a child</para>
            <para>Value: <userinput>Age in years</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>cspace</command>: =num</term>
          <listitem>
            <para>Maximum number of years between children</para>
            <para>Value: <userinput>Number of years</userinput></para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id26">
  <title>Generate Testcases for persons and families</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>testcasegenerator</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>dates</command>: =0/1</term>
          <listitem>
            <para>Whether to create test for date handling.</para>
          <orderedlist>
      <listitem><para>Skip test</para></listitem>
      <listitem><para>Create date tests</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>person_count</command>: =int</term>
          <listitem>
            <para>Number of dummy persons to generate</para>
            <para>Value: <userinput>Number of persons</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>no_trans</command>: =0/1</term>
          <listitem>
            <para>Wheter to use one transaction or multiple small ones</para>
          <orderedlist>
      <listitem><para>One transaction</para></listitem>
      <listitem><para>Multiple transactions</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>long_names</command>: =0/1</term>
          <listitem>
            <para>Wheter to create short or long names</para>
          <orderedlist>
      <listitem><para>Short names</para></listitem>
      <listitem><para>Long names</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>bugs</command>: =0/1</term>
          <listitem>
            <para>Whether to create invalid database references.</para>
          <orderedlist>
      <listitem><para>Skip test</para></listitem>
      <listitem><para>Create invalid Database references</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>persons</command>: =0/1</term>
          <listitem>
            <para>Whether to create a bunch of dummy persons</para>
          <orderedlist>
      <listitem><para>Dont create persons</para></listitem>
      <listitem><para>Create dummy persons</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>add_serial</command>: =0/1</term>
          <listitem>
            <para>Wheter to add a serial number to every text field</para>
          <orderedlist>
      <listitem><para>No serial</para></listitem>
      <listitem><para>Add serial number</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>specialchars</command>: =0/1</term>
          <listitem>
            <para>Wheter to ass some special characters to every text field</para>
          <orderedlist>
      <listitem><para>No special characters</para></listitem>
      <listitem><para>Add special characters</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id27">
  <title>Checkpoint the database</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>chkpoint</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>crcmd</command>: =str</term>
          <listitem>
            <para>Custom command line for retrieval</para>
            <para>Value: <userinput>Custom command string</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>cacmd</command>: =str</term>
          <listitem>
            <para>Custom command line for archiving</para>
            <para>Value: <userinput>Custom command string</userinput></para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>archive</command>: =0/1</term>
          <listitem>
            <para>Whether to archive or retrieve.</para>
          <orderedlist>
      <listitem><para>Retrieve</para></listitem>
      <listitem><para>Archive</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>rcs</command>: =0/1</term>
          <listitem>
            <para>Whether to use RCS (ignores custom commands).</para>
          <orderedlist>
      <listitem><para>Do not use RCS</para></listitem>
      <listitem><para>Use RCS</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id28">
  <title>Rebuild secondary indices</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>rebuild</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id29">
  <title>Dumps gender statistics</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>dgenstats</para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
<sect3 id="cmdplug-id30">
  <title>Generate Commandline Plugin Reference</title>
    <variablelist>
        <varlistentry>
          <term><command>name</command>:</term>
          <listitem>
            <para>cmdref</para>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>include</command>: =0/1</term>
          <listitem>
            <para>Whether to include into the manual</para>
          <orderedlist>
      <listitem><para>Do not include</para></listitem>
      <listitem><para>Include</para></listitem>
          </orderedlist>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><command>target</command>: =str</term>
          <listitem>
            <para>Pathname to the target file</para>
            <para>Value: <userinput>Any valid pathname</userinput></para>
          </listitem>
        </varlistentry>
    </variablelist>
</sect3>
  </sect2>
  
</sect1>