From 1cd75906510f7db447e08005ec8f0ea51548bc59 Mon Sep 17 00:00:00 2001 From: xavierqet Date: Wed, 20 Aug 2008 21:25:53 +0000 Subject: [PATCH] Ajout d'une page de manuel UNIX (en anglais et en francais) git-svn-id: svn+ssh://svn.tuxfamily.org/svnroot/qet/qet/trunk@384 bfdf4180-ca20-0410-9c96-a3a8aa849046 --- man/compress_man_pages.sh | 10 ++++ man/files/fr.ISO8859-1/man1/qelectrotech.1 | 59 ++++++++++++++++++++++ man/files/man1/qelectrotech.1 | 59 ++++++++++++++++++++++ man/uncompress_man_pages.sh | 10 ++++ qelectrotech.pro | 33 ++++++------ 5 files changed, 156 insertions(+), 15 deletions(-) create mode 100755 man/compress_man_pages.sh create mode 100644 man/files/fr.ISO8859-1/man1/qelectrotech.1 create mode 100644 man/files/man1/qelectrotech.1 create mode 100755 man/uncompress_man_pages.sh diff --git a/man/compress_man_pages.sh b/man/compress_man_pages.sh new file mode 100755 index 000000000..3364eded4 --- /dev/null +++ b/man/compress_man_pages.sh @@ -0,0 +1,10 @@ +#!/bin/bash +# Compresses every man page +APP=qelectrotech.1 +MAN_DIR=$(dirname $0)/files + +find ${MAN_DIR} -type f -name "${APP}" -exec gzip {} \; + +# correct files permissions +find ${MAN_DIR} -type d -exec chmod a+rx {} \; +find ${MAN_DIR} -type f -name "${APP}.gz" -exec chmod a+r {} \; diff --git a/man/files/fr.ISO8859-1/man1/qelectrotech.1 b/man/files/fr.ISO8859-1/man1/qelectrotech.1 new file mode 100644 index 000000000..933545eee --- /dev/null +++ b/man/files/fr.ISO8859-1/man1/qelectrotech.1 @@ -0,0 +1,59 @@ +.TH QELECTROTECH 1 "AOÛT 2008" QElectroTech "Manuel utilisateur" +.SH NOM +qelectrotech \- Éditeur de schémas électriques +.SH SYNOPSIS +.B qelectrotech +.B [\-\-common\-elements\-dir\fR=\fIREP\fB] +.B [\-\-config\-dir\-elements\-dir\fR=\fIREP\fB] +.B [\-\-lang\-dir\fR=\fIREP\fB] +.B [\-\-help] +.B [\-v\fR|\fB\-\-version] +.B [\-\-license] +.B [\fIFICHIER\fB]... + +.SH DESCRIPTION +QElectroTech est un éditeur de schémas électriques. Les schémas (*.qet) et les éléments électriques (*.elmt) sont enregistrés au format XML. +Les éléments disposables sur le schéma peuvent provenir de la collection commune ou de la collection utilisateur. +Typiquement, la collection commune est accessible à tous les utilisateurs mais elle n'est pas éditable par eux. +La collection utilisateur est propre à chaque utilisateur et peut être modifiée comme bon lui semble. +.SH OPTIONS +.TP +\fB\-\-common\-elements\-dir\fR=\fIREP\fR +Utilise le dossier REP comme racine de la collection d'éléments commune. Note : cette option n'est activée que si la directive QET_ALLOW_OVERRIDE_CED_OPTION a été spécifiée durant la compilation. +.TP +\fB\-\-config\-dir\-elements\fR=\fIREP\fR +Utilise le dossier REP comme dossier de configuration de l'utilisateur courant. Ce dossier accueille un fichier qelectrotech.conf contenant la configuration de l'application et un sous\-dossier elements contenant la collection d'éléments de l'utilisateur. Note : cette option n'est activée que si la directive QET_ALLOW_OVERRIDE_CD_OPTION a été spécifiée durant la compilation. +.TP +\fB\-\-lang\-dir\fR=\fIREP\fR +Recherche les fichiers de traduction de l'application dans le dossier REP. +.TP +\fB\-\-help\fR +Affiche une courte description des options disponibles +.TP +\fB\-v\fR, \fB\-\-version\fR +Affiche la version de l'application (exemple : 0.1) +.TP +\fB\-\-license\fR +Affiche la licence de l'application (GNU/GPL). +À noter que si l'une des trois dernières options est specifiée dans la ligne de commande, le programme s'arrête après affichage de l'information correspondante. +Si une instance de l'application a déjà été lancée par l'utilisateur, c'est celle\-ci qui prendra en compte la ligne de commande, et notamment les fichiers à ouvrir. +Les options redéfinissant les dossiers (collection commune, répertoire de configuration et fichiers de langue) ne seront toutefois pas pris en compte. +Si le nom d'un fichier à ouvrir se termine par .elmt, QElectroTech essaiera de l'ouvrir dans un éditeur d'élément. +Autrement, il les considérera comme des schémas. +.SH AUTEURS +Benoît Ansieau +.br +Xavier Guerrin + +.SH SIGNALER DES BUGS +Si vous rencontrez un comportement qui vous paraît anormal dans l'application, consultez notre FAQ et notre BugTracker pour voir si le problème n'est pas déjà connu. Dans la négative, soumettez un rapport de bug via le BugTracker. + +.SH COPYRIGHT +Copyright © Les développeurs de QElectroTech +.br +Licence : GNU/GPL v2+ : +.br +Ce programme est un logiciel libre. Vous pouvez le modifier et le redistribuer. Il est fourni tel quel et sans AUCUNE GARANTIE. + +.SH VOIR AUSSI +Site officiel : diff --git a/man/files/man1/qelectrotech.1 b/man/files/man1/qelectrotech.1 new file mode 100644 index 000000000..c9926f66b --- /dev/null +++ b/man/files/man1/qelectrotech.1 @@ -0,0 +1,59 @@ +.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 moidy 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 direvtice has been specified at compilation time. +.TP +\fB\-\-config\-dir\-elements\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 them as diagrams. +.SH AUTHORS +Benoît Ansieau +.br +Xavier Guerrin + +.SH REPORTING BUGS +If you enncounter a behavior in the application that looks unusual to you, browse our FAQ and our BugTracker to check if the problem is already known. In the negative, please submit a bugreport via the BugTracker. + +.SH COPYRIGHT +Copyright © QElectroTech developers. +.br +License : GNU/GPL v2+ : +.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 +Site officiel : diff --git a/man/uncompress_man_pages.sh b/man/uncompress_man_pages.sh new file mode 100755 index 000000000..405963654 --- /dev/null +++ b/man/uncompress_man_pages.sh @@ -0,0 +1,10 @@ +#!/bin/bash +# Uncompresses every man page +APP=qelectrotech.1 +MAN_DIR=$(dirname $0)/files + +find ${MAN_DIR} -type f -name "${APP}.gz" -exec gzip -d {} \; + +# correct files permissions +find ${MAN_DIR} -type d -exec chmod a+rx {} \; +find ${MAN_DIR} -type f -name "${APP}" -exec chmod a+r {} \; diff --git a/qelectrotech.pro b/qelectrotech.pro index ead6fce1d..cfb233d78 100644 --- a/qelectrotech.pro +++ b/qelectrotech.pro @@ -15,6 +15,7 @@ QET_MIME_DESKTOP_PATH = '../share/mimelnk/application/' QET_DESKTOP_PATH = 'share/applications/' QET_ICONS_PATH = 'share/icons/' + QET_MAN_PATH = 'man/' } else { # Chemins Windows COMPIL_PREFIX = './' @@ -188,18 +189,16 @@ CONFIG += debug_and_release warn_on TARGET = qelectrotech # Description de l'installation -target.path = $$join(INSTALL_PREFIX,,,$${QET_BINARY_PATH}) +target.path = $$join(INSTALL_PREFIX,,,$${QET_BINARY_PATH}) -elements.path = $$join(INSTALL_PREFIX,,,$${QET_COMMON_COLLECTION_PATH}) -elements.files = elements/* +elements.path = $$join(INSTALL_PREFIX,,,$${QET_COMMON_COLLECTION_PATH}) +elements.files = elements/* -lang.path = $$join(INSTALL_PREFIX,,,$${QET_LANG_PATH}) -lang.files = $$replace(TRANSLATIONS, '.ts', '.qm') +lang.path = $$join(INSTALL_PREFIX,,,$${QET_LANG_PATH}) +lang.files = $$replace(TRANSLATIONS, '.ts', '.qm') -copyright.path = $$join(INSTALL_PREFIX,,,$${QET_LICENSE_PATH}) -copyright.files = LICENSE \ - CREDIT \ - README +copyright.path = $$join(INSTALL_PREFIX,,,$${QET_LICENSE_PATH}) +copyright.files = LICENSE CREDIT README mime_xml.path = $$join(INSTALL_PREFIX,,,$${QET_MIME_XML_PATH}) mime_xml.files = misc/x-qet-*.xml @@ -207,17 +206,21 @@ mime_xml.files = misc/x-qet-*.xml mime_desktop.path = $$join(INSTALL_PREFIX,,,$${QET_MIME_DESKTOP_PATH}) mime_desktop.files = misc/x-qet-*.desktop -desktop.path = $$join(INSTALL_PREFIX,,,$${QET_DESKTOP_PATH}) -desktop.files = misc/qelectrotech.desktop +desktop.path = $$join(INSTALL_PREFIX,,,$${QET_DESKTOP_PATH}) +desktop.files = misc/qelectrotech.desktop -icons.path = $$join(INSTALL_PREFIX,,,$${QET_ICONS_PATH}) -icons.files = ico/qet.png +icons.path = $$join(INSTALL_PREFIX,,,$${QET_ICONS_PATH}) +icons.files = ico/qet.png + +man.path = $$join(INSTALL_PREFIX,,,$${QET_MAN_PATH}) +man.files = man/files/* +man.extra = sh man/compress_man_pages.sh # L'installation comprend la copie du binaire, des elements, des fichiers de langue et du fichier LICENSE INSTALLS += target elements lang copyright -# Sous Unix, on installe egalement l'icone et un fichier .desktop +# Sous Unix, on installe egalement l'icone, un fichier .desktop, des fichiers mime et les pages de manuel unix { - INSTALLS += desktop mime_xml mime_desktop icons + INSTALLS += desktop mime_xml mime_desktop icons man } # Options de compilation