Doc fix, BPMN objects
[dia.git] / doc / en / dia.1
blob415a2dd75cd7fe29d5356e6ab0c771ce8d08531e
1 .\" ** You probably do not want to edit this file directly **
2 .\" It was generated using the DocBook XSL Stylesheets (version 1.69.0).
3 .\" Instead of manually editing it, you probably should edit the DocBook XML
4 .\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
5 .TH "DIA" "1" "2004\-11\-26" "" ""
6 .\" disable hyphenation
7 .nh
8 .\" disable justification (adjust text to left margin only)
9 .ad l
10 .SH "NAME"
11 dia \- a diagram drawing program
12 .SH "SYNOPSIS"
13 .HP 4
14 \fBdia\fR [\fB\-c\fR] [\fB\-\-credits\fR] [\fB\-e\ \fR\fB\fIOUTPUT\fR\fR] [\fB\-\-export=\fR\fB\fIOUTPUT\fR\fR] [\fB\-L\ \fR\fB\fILAYER,LAYER,...\fR\fR] [\fB\-\-show\-layers=\fR\fB\fILAYER,LAYER,...\fR\fR] [\fB\-h\fR] [\fB\-\-help\fR] [\fB\-n\fR] [\fB\-\-nosplash\fR] [\fB\-s\ \fR\fB\fIWxH\fR\fR] [\fB\-\-size=\fR\fB\fIWxH\fR\fR] [\fB\-t\ \fR\fB\fIFORMAT\fR\fR] [\fB\-\-filter=\fR\fB\fIFORMAT\fR\fR] [\fB\-v\fR] [\fB\-\-version\fR] [file\ ...]
15 .SH "DESCRIPTION"
16 .PP
17 \fBDia\fR 
18 is used to create diagrams. Dia has a number of basic tools, like lines and boxes but can also dynamically load 
19 \fIsheets\fR. A sheet is a collection of tools that are used in a certain type of diagram.
20 .PP
21 Most diagram objects in 
22 \fBDia\fR 
23 have 
24 \fIconnection points\fR. Lines can be connected to these connection points and this way graph structures can be formed. When objects are moved or resized the connections will follow the objects.
25 .PP
26 Diagrams drawn in 
27 \fBDia\fR 
28 can be exported PostScript.
29 .SH "OPTIONS"
30 .PP
31 \fBDia\fR 
32 accepts the following options:
33 .TP
34 \fB\-c\fR \fB\-\-credits\fR
35 Display credits list and exit.
36 .TP
37 \fB\-e \fR\fB\fIOUTPUT\fR\fR \fB\-\-export=\fR\fB\fIOUTPUT\fR\fR
38 Export loaded file to OUTPUT and exit.
39 .TP
40 \fB\-h\fR \fB\-\-help\fR
41 Display a list of all commandline options.
42 .TP
43 \fB\-n\fR \fB\-\-nosplash\fR
44 Do not show the splash screen.
45 .TP
46 \fB\-s \fR\fB\fIWxH\fR\fR \fB\-\-size=\fR\fB\fIWxH\fR\fR
47 Export loaded file in decimal given width and/or height. It is allowed to only select width or height. E.g. 
48 \fB\-\-size=\fR\fB\fI520x\fR\fR 
49 exports an image that is 520 pixels wide, while 
50 \fB\-\-size=\fR\fB\fIx900\fR\fR 
51 exports an image of 900 pixels height.
52 .sp
53 .it 1 an-trap
54 .nr an-no-space-flag 1
55 .nr an-break-flag 1
56 .br
57 \fBNote\fR
58 This option is currently only implemented for the PNG export filter.
59 .TP
60 \fB\-L \fR\fB\fILAYER,LAYER,...\fR\fR \fB\-\-show\-layers=\fR\fB\fILAYER,LAYER,...\fR\fR
61 Only include specified layers when exporting. Layers can be specified either as a layer name, the layer number or a numeric range X\-Y of layers. \-\-show\-layers=background,2\-5 shows the layer named background and layers 2\-5, \-\-show\-layers=2\- shows layers 2 and up.
62 .TP
63 \fB\-t \fR\fB\fIFORMAT\fR\fR \fB\-\-export\-to\-format=\fR\fB\fIFORMAT\fR\fR
64 Export loaded file in FORMAT and exit. Format are described below.
65 .TP
66 \fB\-v\fR \fB\-\-version\fR
67 Display 
68 \fBdia\fR 
69 version and exit.
70 .SH "EXPORT FORMATS"
71 .PP
72 The following export formats are supported by 
73 \fBdia\fR.
74 .TP 3
75 \(bu
76 cgm 
77 (Computer Graphics Metafile, ISO 8632)
78 .TP
79 \(bu
80 dia 
81 (Native dia diagram)
82 .TP
83 \(bu
84 dxf 
85 (Drawing Interchange File)
86 .TP
87 \(bu
88 eps 
89 or 
90 eps\-builtin 
91 or 
92 eps\-pango 
93 (Encapsulated PostScript)
95 The format specifications 
96 eps 
97 and 
98 eps\-pango 
99 both use the font renderer of the Pango library, while 
100 eps\-builtin 
101 uses a dia specific font renderer. If you have problems with Pango rendering, e.g. Unicode, try 
102 eps\-builtin 
103 instead.
105 \(bu
106 fig 
107 (XFig format)
109 \(bu
110 mp 
111 (TeX MetaPost macros)
113 \(bu
114 plt 
115 or 
116 hpgl 
117 (HP Graphics Language)
119 \(bu
120 png 
121 (Portable Network Graphics)
123 \(bu
124 shape 
125 (Dia Shape File)
127 \(bu
128 svg 
129 (Scalable Vector Graphics)
131 \(bu
132 tex 
133 (TeX PSTricks macros)
135 \(bu
136 wpg 
137 (WordPerfect Graphics)
139 \(bu
140 wmf 
141 (Windows MetaFile)
142 .SH "FILES"
144 \fBdia\fR 
145 creates a directory 
146 \fI.dia\fR 
147 in the user's home, which contains different files to store user preferences. To reset 
148 \fBdia\fR 
149 to it's default behaviour, just remove the respective file:
150 .TP 3
151 \(bu
152 \fIdefaults.dia\fR: contains default values for elements (XML format).
154 \(bu
155 \fIdiarc\fR: keeps 
156 \fBdia\fR 
157 preferences (ASCII).
159 \(bu
160 \fIhistory\fR: keeps the list of last edited diagrams (ASCII).
162 \(bu
163 \fImenurc\fR: contains an automated accelerator map dump (Lisp).
165 \(bu
166 \fIpersistence\fR: contains GUI information, e.g. open windows (XML).
168 \(bu
169 \fIpluginrc\fR: the list of loaded plugins (XML).
170 .SH "SEE ALSO"
172 [1]\&\fIPango\fR
174 X (1)
176 xfig (1)
178 inkscape (1)
179 .SH "COPYRIGHT"
181 Copyright 1999 Alexander Larsson.
183 Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation.
184 .SH "AUTHORS"
186 Alexander Larsson
188 This manual was written by 
189 Fredrik Hallenberg.
190 .SH "AUTHOR"
191 Fredrik Hallenberg <hallon@lysator.liu.se>, W. Borgert <debacle@debian.org>, Alan Horkan <horkana@tcd.ie>. 
192 .SH "REFERENCES"
193 .TP 3
194 1.\ Pango
195 \%http://www.pango.org/