~ubuntu-branches/ubuntu/utopic/tcm/utopic

« back to all changes in this revision

Viewing changes to man/man1/tscd.1

  • Committer: Bazaar Package Importer
  • Author(s): Otavio Salvador
  • Date: 2003-07-03 20:08:21 UTC
  • Revision ID: james.westby@ubuntu.com-20030703200821-se4xtqx25e5miczi
Tags: upstream-2.20
ImportĀ upstreamĀ versionĀ 2.20

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH TSCD 1 "19 March 2002"
 
2
.SH NAME
 
3
tscd \- Tool for UML Statechart Diagrams
 
4
.SH SYNOPSIS
 
5
.B tscd
 
6
.RI [ options ]
 
7
.RI [ document ]
 
8
.SH DESCRIPTION
 
9
\fItscd\fP
 
10
is an X11/Motif based graphical editor for drawing UML statechart
 
11
diagrams. Documents can be loaded from and stored to a file. It can print
 
12
documents to a PostScript printer or save as PostScript to a file.
 
13
 
 
14
\fItscd\fP is part of \fIThe Toolkit for Conceptual Modeling (TCM)\fP.
 
15
 
 
16
.SH ARGUMENTS
 
17
You can call \fItscd\fP with a single document name as argument. 
 
18
If this argument is an existing file then \fItscd\fP
 
19
tries to load a document from it. If it does not exist, a new document
 
20
is created with the argument as document name. \fItscd\fP files should
 
21
have suffix '*.scd'.
 
22
 
 
23
Without a document argument, \fItscd\fP creates a new 
 
24
empty statechart diagram with the name 'untitled.scd'.
 
25
 
 
26
In addition to the standard X11 toolkit options (see X11(7)), \fItscd\fP accepts
 
27
the options listed below:
 
28
.TP
 
29
.B \-drawing \fIwidth\fPx\fIheight\fP
 
30
Create a drawing area of \fIwidth\fP pixels wide and
 
31
\fIheight\fP pixels high.
 
32
.TP
 
33
.B \-help
 
34
Write all available options to standard output and quit.
 
35
.TP
 
36
.B \-maxdrawing \fIwidth\fPx\fIheight\fP
 
37
The drawing area can not be larger than \fIwidth\fP pixels wide and
 
38
\fIheight\fP pixels high.
 
39
.TP
 
40
.B \-priv_cmap 
 
41
Start the editor with a private colormap.
 
42
.TP
 
43
.B \-projdir \fIdirectory\fP 
 
44
Set the project directory (current working directory) to \fIdirectory\fP.
 
45
.TP
 
46
.B \-toPS [\fIfile\fP.ps]
 
47
Generate PostScript (to \fIfile\fP.ps or stdout when no file name was
 
48
given) and quit.
 
49
.TP
 
50
.B \-toEPS [\fIfile\fP.eps]
 
51
Generate EPS (to \fIfile\fP.eps or stdout when no file name was 
 
52
given) and quit.
 
53
.TP
 
54
.B \-toFig [\fIfile\fP.fig] [-latex]
 
55
Generate Fig format (to \fIfile\fP.fig or stdout when no file name was
 
56
given and quit. When the -latex option is given, LaTeX fonts are
 
57
generated, otherwise normal PostScript fonts are generated.
 
58
The Fig format can be read by xfig(1) and fig2dev(1).
 
59
.TP
 
60
.B \-toPNG \fIfile\fP.png
 
61
Generate PNG format to \fIfile\fP.png and quit.
 
62
.TP
 
63
.B \-toPS [\fIfile\fP.ps]
 
64
Generate PostScript (to \fIfile\fP.ps or stdout when no file name was
 
65
given) and quit.
 
66
.TP
 
67
.B \-version
 
68
Write the TCM version to standard output and quit.
 
69
 
 
70
.SH ENVIRONMENT
 
71
The \fBTCM_HOME\fP environment variable should be the directory
 
72
where the TCM files are installed.
 
73
 
 
74
.TP
 
75
.B PATH   
 
76
Should include $TCM_HOME/bin
 
77
.TP
 
78
.B MANPATH
 
79
Should include $TCM_HOME/man
 
80
.TP
 
81
.B PRINTER
 
82
Name of the default printer that is used by \fItscd\fP.
 
83
.TP
 
84
.B LD_LIBRARY_PATH
 
85
Should include $TCM_HOME/lib when the distribution contains shared
 
86
object libraries in $TCM_HOME/lib.
 
87
 
 
88
.SH FILES
 
89
The following relative files are relative to $TCM_HOME.
 
90
.TP
 
91
\fIbin/tscd\fP 
 
92
the statechart diagram editor.
 
93
.TP
 
94
\fIbin/psf\fP 
 
95
a program to filter PostScript output.
 
96
.TP
 
97
\fIlib/banner.ps\fP
 
98
PostScript banner page that can be used when the printer
 
99
does not print a banner page.
 
100
.TP
 
101
\fIlib/help/*\fP
 
102
The help directory contains a collection of text files for
 
103
the on-line help.
 
104
.TP
 
105
\fIlib/TCM\fP
 
106
X Resources (the same as the ones that are built-in).
 
107
You can customize the fonts and colors by setting resources
 
108
in your X defaults database.  Each string of the form
 
109
``TCM.resource:definition'' sets a resource.
 
110
.TP
 
111
.I /tmp/tcmXXXXXX
 
112
Pseudo random temporary file, for PostScript output.
 
113
.TP
 
114
\fIlib/tcm.conf\fP
 
115
TCM editor configuration file. This file contains values
 
116
for some of the editor defaults like the page size, the default 
 
117
fonts etc. This file is read by each editor upon startup.
 
118
.TP
 
119
\fI$HOME/.tcmrc\fP
 
120
Each user of TCM can override some of the options of tcm.conf
 
121
by its own configuration file, installed in $HOME/.tcmrc.
 
122
 
 
123
 
 
124
.SH SEE ALSO
 
125
Frank Dehne, Roel Wieringa and Henk van de Zandschulp -- 
 
126
TCM (Toolkit for Conceptual Modeling),
 
127
User's Guide and Reference.
 
128
This document is available as PostScript and HTML
 
129
in $TCM_HOME/doc or as HTML via the URL
 
130
http://www.cs.utwente.nl/~tcm/tcm-usersguide.html.
 
131
 
 
132
tcm(1), X11(7), xfig(1), fig2dev(1)
 
133
 
 
134
.SH AUTHOR
 
135
David N. Jansen (dnjansen@cs.utwente.nl).
 
136
 
 
137
.SH BUGS
 
138
Please send bug reports to tcm@cs.utwente.nl.
 
139