mirror of
https://github.com/qelectrotech/qelectrotech-source-mirror.git
synced 2025-09-13 20:23:04 +02:00
4da7e54d75
git-svn-id: svn+ssh://svn.tuxfamily.org/svnroot/qet/qet/trunk@558 bfdf4180-ca20-0410-9c96-a3a8aa849046
60 lines
2.9 KiB
Groff
60 lines
2.9 KiB
Groff
.TH QELECTROTECH 1 "AUGUST 2008" QElectroTech "User Manual"
|
|
.SH NAME
|
|
qelectrotech \- Electric diagrams editor
|
|
.SH SYNOPSIS
|
|
.B qelectrotech
|
|
.B [\-\-common\-elements\-dir\fR=\fIDIR\fB]
|
|
.B [\-\-config\-dir\-elements\-dir\fR=\fIDIR\fB]
|
|
.B [\-\-lang\-dir\fR=\fIDIR\fB]
|
|
.B [\-\-help]
|
|
.B [\-v\fR|\fB\-\-version]
|
|
.B [\-\-license]
|
|
.B [\fIFILE\fB]...
|
|
|
|
.SH DESCRIPTION
|
|
QElectroTech is an electric diagrams editor. Diagrams (*.qet) and electric elements (*.elmt) are stored using the XML format.
|
|
The elements that can be used in diagrams may come from the common collection or from the user's custom collection.
|
|
Typically, the common collection is readable by all users but it can't be edited by them.
|
|
Each user owns its custom collection he can modify as he wants.
|
|
.SH OPTIONS
|
|
.TP
|
|
\fB\-\-common\-elements\-dir\fR=\fIDIR\fR
|
|
Uses DIR as the common collection root directory. Note : this option is enabled only if the QET_ALLOW_OVERRIDE_CED_OPTION directive has been specified at compilation time.
|
|
.TP
|
|
\fB\-\-config\-dir\fR=\fIDIR\fR
|
|
Uses DIR as the current user's configuration directory. This directory hosts a file named qelectrotech.conf, which contains the application configuration, and a subdirectory named elements, which contains the user's elements collection. Note : this option is enabled only if the QET_ALLOW_OVERRIDE_CD_OPTION directive has been specified at compilation time.
|
|
.TP
|
|
\fB\-\-lang\-dir\fR=\fIDIR\fR
|
|
Looks for the application translation files in the directory DIR.
|
|
.TP
|
|
\fB\-\-help\fR
|
|
Displays a short description of the available options.
|
|
.TP
|
|
\fB\-v\fR, \fB\-\-version\fR
|
|
Displays the application version (e.g.: 0.1).
|
|
.TP
|
|
\fB\-\-license\fR
|
|
Displays the application license (GNU/GPL).
|
|
Note that if one of the three last options is specified in the command line, the programs stops after having displayed the adequate information.
|
|
If an instance of the application launched by the user is still running, this instance will consider the command line, and notably the files to open.
|
|
However, options that redefine directories (common collection, configuration and translation files) will not be considered.
|
|
If a filename ends with .elmt, QElectroTech will try to open it into an element editor.
|
|
Otherwise, it will consider it as diagrams.
|
|
.SH AUTHORS
|
|
Benoit Ansieau <benoit.ansieau@gmail.com>
|
|
.br
|
|
Xavier Guerrin <xavier.guerrin@gmail.com>
|
|
|
|
.SH REPORTING BUGS
|
|
If you encounter a behavior in the application that looks unusual to you, browse our FAQ <http://qelectrotech.org/wiki/doku.php?id=doc:faq> and our BugTracker <http://qelectrotech.org/bugtracker/> to check if the problem is already known. In the negative, please submit a bugreport via the BugTracker.
|
|
|
|
.SH COPYRIGHT
|
|
Copyright (c) QElectroTech developers.
|
|
.br
|
|
License : GNU/GPL v2+ : <http://www.gnu.org/licenses/old\-licenses/gpl\-2.0.html>
|
|
.br
|
|
This program is a free software. You can modify and redistribute it. It is provided as is and WITHOUT ANY WARRANTY.
|
|
|
|
.SH SEE ALSO
|
|
Official website : <http://qelectrotech.org/>
|