doc/en/dia.dbk

   1 <?xml version='1.0' encoding='ISO-8859-1'?>
   2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
   4
   5 <refentry>
   6   <refentryinfo>
   7     <copyright>
   8       <year>1999</year>
   9       <year>2004</year>
  10       <holder>Fredrik Hallenberg, W. Borgert, Alan Horkan</holder>
  11     </copyright>
  12     <date>2004-11-26</date>
  13     <authorgroup>
  14       <author>
  15         <firstname>Fredrik</firstname>
  16         <surname>Hallenberg</surname>
  17         <email>hallon@lysator.liu.se</email>
  18       </author>
  19       <author>
  20         <firstname>W.</firstname>
  21         <surname>Borgert</surname>
  22         <email>debacle@debian.org</email>
  23       </author>
  24       <author>
  25         <firstname>Alan</firstname>
  26         <surname>Horkan</surname>
  27         <email>horkana@tcd.ie</email>
  28       </author>
  29     </authorgroup>
  30     <revhistory>
  31       <revision>
  32         <revnumber>4</revnumber>
  33         <date>2004-11-26</date>
  34         <authorinitials>AH</authorinitials>
  35         <revremark>added to See Also, corrected grammar</revremark>
  36       </revision>
  37       <revision>
  38         <revnumber>3</revnumber>
  39         <date>2003-11-26</date>
  40         <authorinitials>WB</authorinitials>
  41         <revremark>added --size option</revremark>
  42       </revision>
  43       <revision>
  44         <revnumber>2</revnumber>
  45         <date>2003-10-16</date>
  46         <authorinitials>WB</authorinitials>
  47         <revremark>added different EPS variants and section on
  48         files</revremark>
  49       </revision>
  50       <revision>
  51         <revnumber>1</revnumber>
  52         <date>2003-10-12</date>
  53         <authorinitials>WB</authorinitials>
  54         <revremark>1st DocBook/XML version</revremark>
  55       </revision>
  56     </revhistory>
  57   </refentryinfo>
  58
  59   <refmeta>
  60     <refentrytitle>dia</refentrytitle>
  61
  62     <manvolnum>1</manvolnum>
  63   </refmeta>
  64
  65   <refnamediv>
  66     <refname>dia</refname>
  67
  68     <refpurpose>a diagram drawing program</refpurpose>
  69   </refnamediv>
  70
  71   <refsynopsisdiv>
  72     <cmdsynopsis>
  73       <command>dia</command>
  74
  75       <arg><option>-c</option></arg>
  76
  77       <arg><option>--credits</option></arg>
  78
  79       <arg><option>-e <replaceable>OUTPUT</replaceable></option></arg>
  80
  81       <arg><option>--export=<replaceable>OUTPUT</replaceable></option></arg>
  82
  83       <arg><option>-L <replaceable>LAYER,LAYER,...</replaceable></option></arg>
  84
  85       <arg><option>--show-layers=<replaceable>LAYER,LAYER,...</replaceable></option></arg>
  86
  87       <arg><option>-h</option></arg>
  88
  89       <arg><option>--help</option></arg>
  90
  91       <arg><option>-n</option></arg>
  92
  93       <arg><option>--nosplash</option></arg>
  94
  95       <arg><option>-s <replaceable>WxH</replaceable></option></arg>
  96
  97       <arg><option>--size=<replaceable>WxH</replaceable></option></arg>
  98
  99       <arg><option>-t <replaceable>FORMAT</replaceable></option></arg>
 100
 101       <arg><option>--filter=<replaceable>FORMAT</replaceable></option></arg>
 102
 103       <arg><option>-v</option></arg>
 104
 105       <arg><option>--version</option></arg>
 106
 107       <arg>file ...</arg>
 108     </cmdsynopsis>
 109   </refsynopsisdiv>
 110
 111   <refsect1>
 112     <title>Description</title>
 113
 114     <para><command>Dia</command> is used to create diagrams.  Dia has
 115     a number of basic tools, like lines and boxes but can also
 116     dynamically load <emphasis>sheets</emphasis>.  A sheet is a
 117     collection of tools that are used in a certain type of
 118     diagram.</para>
 119
 120     <para>Most diagram objects in <command>Dia</command> have
 121     <emphasis>connection points</emphasis>.  Lines can be connected to
 122     these connection points and this way graph structures can be formed.
 123     When objects are moved or resized the connections will follow the
 124     objects.</para>
 125
 126     <para>Diagrams drawn in <command>Dia</command> can be exported
 127     PostScript.</para>
 128   </refsect1>
 129
 130   <refsect1>
 131     <title>Options</title>
 132
 133     <para><command>Dia</command> accepts the following options:</para>
 134
 135     <variablelist>
 136       <varlistentry>
 137         <term><option>-c</option>
 138           <option>--credits</option></term>
 139         <listitem>
 140           <para>Display credits list and exit.</para>
 141         </listitem>
 142       </varlistentry>
 143       <varlistentry>
 144         <term><option>-e <replaceable>OUTPUT</replaceable></option>
 145           <option>--export=<replaceable>OUTPUT</replaceable></option></term>
 146         <listitem>
 147           <para>Export loaded file to OUTPUT and exit.</para>
 148         </listitem>
 149       </varlistentry>
 150       <varlistentry>
 151         <term><option>-h</option>
 152           <option>--help</option></term>
 153         <listitem>
 154           <para>Display a list of all commandline options.</para>
 155         </listitem>
 156       </varlistentry>
 157       <varlistentry>
 158         <term><option>-n</option>
 159           <option>--nosplash</option></term>
 160         <listitem>
 161           <para>Do not show the splash screen.</para>
 162         </listitem>
 163       </varlistentry>
 164       <varlistentry>
 165         <term><option>-s <replaceable>WxH</replaceable></option>
 166           <option>--size=<replaceable>WxH</replaceable></option></term>
 167         <listitem>
 168           <para>Export loaded file in decimal given width and/or
 169           height.  It is allowed to only select width or height.
 170           E.g. <option>--size=<replaceable>520x</replaceable></option>
 171           exports an image that is 520 pixels wide, while
 172           <option>--size=<replaceable>x900</replaceable></option>
 173           exports an image of 900 pixels height.</para>
 174
 175           <note>
 176             <para>This option is currently only implemented for the
 177             PNG export filter.</para>
 178           </note>
 179         </listitem>
 180       </varlistentry>
 181       <varlistentry>
 182         <term><option>-L <replaceable>LAYER,LAYER,...</replaceable></option>
 183           <option>--show-layers=<replaceable>LAYER,LAYER,...</replaceable></option></term>
 184         <listitem>
 185           <para>Only include specified layers when exporting. Layers can be
 186           specified either as a layer name, the layer number or a numeric
 187           range X-Y of layers. --show-layers=background,2-5 shows the layer
 188           named background and layers 2-5, --show-layers=2- shows layers 2 and
 189           up.</para>
 190         </listitem>
 191       </varlistentry>
 192       <varlistentry>
 193         <term><option>-t <replaceable>FORMAT</replaceable></option>
 194           <option>--export-to-format=<replaceable>FORMAT</replaceable></option></term>
 195         <listitem>
 196           <para>Export loaded file in FORMAT and exit.  Format are
 197           described below.</para>
 198         </listitem>
 199       </varlistentry>
 200       <varlistentry>
 201         <term><option>-v</option>
 202           <option>--version</option></term>
 203         <listitem>
 204           <para>Display <command>dia</command> version and exit.</para>
 205         </listitem>
 206       </varlistentry>
 207     </variablelist>
 208   </refsect1>
 209
 210   <refsect1>
 211     <title>Export Formats</title>
 212
 213     <para>The following export formats are supported by
 214     <command>dia</command>.</para>
 215
 216     <itemizedlist>
 217       <listitem>
 218         <para><literal>cgm</literal> (Computer Graphics Metafile, ISO
 219         8632)</para>
 220       </listitem>
 221
 222       <listitem>
 223         <para><literal>dia</literal> (Native dia diagram)</para>
 224       </listitem>
 225
 226       <listitem>
 227         <para><literal>dxf</literal> (Drawing Interchange File)</para>
 228       </listitem>
 229
 230       <listitem>
 231         <para><literal>eps</literal>  or
 232         <literal>eps-builtin</literal> or <literal>eps-pango</literal>
 233         (Encapsulated PostScript)</para>
 234
 235         <para>The format specifications <literal>eps</literal> and <literal>eps-pango</literal> both
 236         use the font renderer of the Pango library, while
 237         <literal>eps-builtin</literal> uses a dia specific font
 238         renderer.  If you have problems with Pango rendering,
 239         e.g. Unicode, try <literal>eps-builtin</literal>
 240         instead.</para>
 241       </listitem>
 242
 243       <listitem>
 244         <para><literal>fig</literal> (XFig format)</para>
 245       </listitem>
 246
 247       <listitem>
 248         <para><literal>mp</literal> (TeX MetaPost macros)</para>
 249       </listitem>
 250
 251       <listitem>
 252         <para><literal>plt</literal> or <literal>hpgl</literal> (HP
 253         Graphics Language)</para>
 254       </listitem>
 255
 256       <listitem>
 257         <para><literal>png</literal> (Portable Network
 258         Graphics)</para>
 259       </listitem>
 260
 261       <listitem>
 262         <para><literal>shape</literal> (Dia Shape File)</para>
 263       </listitem>
 264
 265       <listitem>
 266         <para><literal>svg</literal> (Scalable Vector Graphics)</para>
 267       </listitem>
 268
 269       <listitem>
 270         <para><literal>tex</literal> (TeX PSTricks macros)</para>
 271       </listitem>
 272
 273       <listitem>
 274         <para><literal>wpg</literal> (WordPerfect Graphics)</para>
 275       </listitem>
 276
 277       <listitem arch="win32">
 278         <para><literal>wmf</literal> (Windows MetaFile)</para>
 279       </listitem>
 280     </itemizedlist>
 281   </refsect1>
 282
 283   <refsect1>
 284     <title>Files</title>
 285
 286     <para><command>dia</command> creates a directory
 287     <filename>.dia</filename> in the user&apos;s home, which contains
 288     different files to store user preferences.  To reset
 289     <command>dia</command> to it&apos;s default behaviour, just remove
 290     the respective file:</para>
 291
 292     <itemizedlist>
 293       <listitem>
 294         <para><filename>defaults.dia</filename>: contains default
 295         values for elements (XML format).</para>
 296       </listitem>
 297       <listitem>
 298         <para><filename>diarc</filename>: keeps
 299         <command>dia</command> preferences (ASCII).</para>
 300       </listitem>
 301       <listitem>
 302         <para><filename>history</filename>: keeps the list of last
 303         edited diagrams (ASCII).</para>
 304       </listitem>
 305       <listitem>
 306         <para><filename>menurc</filename>: contains an automated
 307         accelerator map dump (Lisp).</para>
 308       </listitem>
 309       <listitem>
 310         <para><filename>persistence</filename>: contains GUI
 311         information, e.g. open windows (XML).</para>
 312       </listitem>
 313       <listitem>
 314         <para><filename>pluginrc</filename>: the list of loaded
 315         plugins (XML).</para>
 316       </listitem>
 317     </itemizedlist>
 318   </refsect1>
 319
 320   <refsect1>
 321     <title>See Also</title>
 322
 323     <para><ulink url="http://www.pango.org/">Pango</ulink></para>
 324     <para>X (1)</para>
 325     <para>xfig (1)</para>
 326     <para>inkscape (1)</para>
 327   </refsect1>
 328
 329   <refsect1>
 330     <title>Copyright</title>
 331
 332     <para>Copyright 1999 Alexander Larsson.</para>
 333
 334     <para>Permission to use, copy, modify, and distribute this
 335     software and its documentation for any purpose and without fee is
 336     hereby granted, provided that the above copyright notice appear in
 337     all copies and that both that copyright notice and this permission
 338     notice appear in supporting documentation.</para>
 339   </refsect1>
 340
 341   <refsect1>
 342     <title>Authors</title>
 343
 344     <para><author><firstname>Alexander</firstname>
 345         <surname>Larsson</surname>
 346         <email>alla@lysator.liu.se</email></author></para>
 347
 348     <para>This manual was written by
 349     <author><firstname>Fredrik</firstname>
 350         <surname>Hallenberg</surname>
 351         <email>hallon@lysator.liu.se</email></author>.</para>
 352   </refsect1>
 353 </refentry>