GNOME.org
 

[gnome-latex: 200/205] Added a manpage.

commit 7a98ce00db551966b5d7f70e389cd1d32355bc93
Author: Tanguy Ortolo <tanguy+latexila ortolo eu>
Date:   Thu Apr 29 14:10:34 2010 +0200

    Added a manpage.
    
    The manpage source is written in DocBook V5.0 format. It can be compiled to the
    usual roff manpage format with a DocBook-XSL stylesheet.
    
    For convenience, the manpage is provided in compiled roff format: though
    compiled, it is a human-readable format. It is this version that gets installed
    with CMake.

 CMakeLists.txt     |   1 +
 man/CMakeLists.txt |   1 +
 man/latexila.1     | 104 +++++++++++++++++++++++++++++++
 man/latexila.1.xml | 177 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 4 files changed, 283 insertions(+)
---
diff --git a/CMakeLists.txt b/CMakeLists.txt
index 4a8b0fa..575e017 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -81,3 +81,4 @@ CONFIGURE_FILE(${latexila_SOURCE_DIR}/src/config.h.cmake
 
 ADD_SUBDIRECTORY(src)
 ADD_SUBDIRECTORY(data)
+ADD_SUBDIRECTORY(man)
diff --git a/man/CMakeLists.txt b/man/CMakeLists.txt
new file mode 100644
index 0000000..3a28b15
--- /dev/null
+++ b/man/CMakeLists.txt
@@ -0,0 +1 @@
+INSTALL(FILES latexila.1 DESTINATION share/man/man1)
diff --git a/man/latexila.1 b/man/latexila.1
new file mode 100644
index 0000000..54f6ed6
--- /dev/null
+++ b/man/latexila.1
@@ -0,0 +1,104 @@
+'\" t
+.\"     Title: LATEXILA
+.\"    Author: Tanguy Ortolo <tanguy+debian ortolo eu>
+.\" Generator: DocBook XSL-NS Stylesheets v1.75.2 <http://docbook.sf.net/>
+.\"      Date: 04/29/2010
+.\"    Manual: User commands
+.\"    Source: LaTeXila
+.\"  Language: English
+.\"
+.TH "LATEXILA" "1" "04/29/2010" "LaTeXila" "User commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+latexila \- LaTeX editor for the GNOME desktop
+.SH "SYNOPSIS"
+.HP \w'\fBlatexila\fR\ 'u
+\fBlatexila\fR [\fIFILES\fR]
+.HP \w'\fBlatexila\fR\ 'u
+\fBlatexila\fR {\fB\-n\fR | \fB\-\-new\-document\fR}
+.HP \w'\fBlatexila\fR\ 'u
+\fBlatexila\fR {\fB\-h\fR | \fB\-\-help\fR | \fB\-\-help\-all\fR | \fB\-\-help\-gtk\fR}
+.SH "DESCRIPTION"
+.PP
+This manual page documents briefly the
+\fBlatexila\fR
+command\&. It was written for the Debian distribution because the original program does not have a manual 
page\&.
+.PP
+LaTeXila
+is a LaTeX editor designed for the GNOME desktop environment\&.
+.SH "OPTIONS"
+.PP
+The program follows the usual GNU command line syntax, with long options starting with two dashes 
(`\-\*(Aq)\&. A summary of options is included below\&. For a complete description of options, please use
+\fBlatexila \-\-help\fR\&.
+.PP
+\fB\-n\fR, \fB\-\-new\-document\fR
+.RS 4
+Create a new document\&.
+.RE
+.PP
+\fB\-h\fR, \fB\-\-help\fR
+.RS 4
+Show summary of common options\&.
+.RE
+.PP
+\fB\-\-help\-all\fR
+.RS 4
+Show summary of all options\&.
+.RE
+.PP
+\fB\-\-help\-gtk\fR
+.RS 4
+Show summary of GTK+ options\&.
+.RE
+.PP
+\fB\-v\fR, \fB\-\-version\fR
+.RS 4
+Display version information\&.
+.RE
+.SH "NOTES"
+.PP
+By default, when
+LaTeXila
+is started it reopens the files that were open last time it was used\&. This behaviour can be disabled in 
the program\*(Aqs preferences\&.
+.SH "BUGS"
+.PP
+The upstreams
+BTS
+can be found at
+\m[blue]\fBhttp://sourceforge\&.net/tracker/?group_id=271323\fR\m[]\&;.
+.SH "AUTHOR"
+.PP
+\fBTanguy Ortolo\fR <\&tanguy+debian@ortolo\&.eu\&>
+.RS 4
+Wrote this manpage for the Debian system\&.
+.RE
+.SH "COPYRIGHT"
+.br
+Copyright \(co 2010 Tanguy Ortolo
+.br
+.PP
+This manual page was written for the Debian system (and may be used by others)\&.
+.PP
+Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General 
Public License, Version 3 or (at your option) any later version published by the Free Software Foundation\&.
+.PP
+On Debian systems, the complete text of the GNU General Public License can be found in
+/usr/share/common\-licenses/GPL\&.
+.sp
diff --git a/man/latexila.1.xml b/man/latexila.1.xml
new file mode 100644
index 0000000..becbb63
--- /dev/null
+++ b/man/latexila.1.xml
@@ -0,0 +1,177 @@
+<?xml version='1.0' encoding='utf-8'?>
+<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V5.0//EN" "http://docbook.org/xml/5.0/dtd/docbook.dtd"; [
+
+<!--
+
+`xsltproc /usr/share/xml/docbook/stylesheet/docbook-xsl-ns/manpages/docbook.xsl \
+          latexila.1.xml'
+
+A manual page <package>.<section> will be generated. You may view the
+manual page with: man -l <package>.<section>'. A typical entry in a Makefile or
+Makefile.am is:
+
+DB2MAN = /usr/share/xml/docbook/stylesheet/docbook-xsl-ns/manpages/docbook.xsl
+XP     = xsltproc
+
+latexila.1: latexila.1.xml
+        $(XP) $(DB2MAN) $<
+
+The xsltproc binary is found in the xsltproc package. The XSL files are in
+docbook-xsl-ns. A description of the parameters you can use can be found in the
+docbook-xsl-doc-* packages.
+
+Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
+
+General documentation about man-pages and man-page-formatting:
+man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
+
+-->
+
+  <!ENTITY authorfirstname "Tanguy">
+  <!ENTITY authorsurname   "Ortolo">
+  <!ENTITY authorfullname  "&authorfirstname; &authorsurname;">
+  <!ENTITY authoremail     "tanguy+debian ortolo eu">
+  <!ENTITY mansection      "1">
+  <!ENTITY mansectitle     "User Commands">
+  <!ENTITY upcommand       "LATEXILA">
+  <!ENTITY command         "latexila">
+  <!ENTITY program         "LaTeXila">
+]>
+
+<article xmlns="http://docbook.org/ns/docbook"; version="5.0" xmlns:xlink="http://www.w3.org/1999/xlink"; 
xml:lang="en">
+<title>User commands</title>
+<refentry xml:id="&command;">
+  <info>
+    <productname>&program;</productname>
+
+    <authorgroup>
+      <author>
+        <personname><firstname>&authorfirstname;</firstname><surname>&authorsurname;</surname></personname>
+        <contrib>Wrote this manpage for the Debian system.</contrib>
+        <address><email>&authoremail;</email></address>
+      </author>
+    </authorgroup>
+
+    <copyright>
+      <year>2010</year>
+      <holder>&authorfullname;</holder>
+    </copyright>
+
+    <legalnotice>
+      <para>This manual page was written for the Debian system
+        (and may be used by others).</para>
+      <para>Permission is granted to copy, distribute and/or modify this
+        document under the terms of the GNU General Public License,
+        Version 3 or (at your option) any later version published by
+        the Free Software Foundation.</para>
+      <para>On Debian systems, the complete text of the GNU General Public
+        License can be found in
+        <filename>/usr/share/common-licenses/GPL</filename>.</para>
+    </legalnotice>
+  </info>
+
+  <refmeta>
+    <refentrytitle>&upcommand;</refentrytitle>
+    <manvolnum>&mansection;</manvolnum>
+  </refmeta>
+
+  <refnamediv>
+    <refname>&command;</refname>
+    <refpurpose>LaTeX editor for the GNOME desktop</refpurpose>
+  </refnamediv>
+
+  <refsynopsisdiv>
+    <cmdsynopsis>
+        <command>&command;</command>
+        <arg choice="opt"><replaceable>FILES</replaceable></arg>
+    </cmdsynopsis>
+
+    <cmdsynopsis>
+      <command>&command;</command>
+      <group choice="req">
+        <arg choice="plain"><option>-n</option></arg>
+        <arg choice="plain"><option>--new-document</option></arg>
+      </group>
+    </cmdsynopsis>
+
+    <cmdsynopsis>
+      <command>&command;</command>
+      <group choice="req">
+        <arg choice="plain"><option>-h</option></arg>
+        <arg choice="plain"><option>--help</option></arg>
+        <arg choice="plain"><option>--help-all</option></arg>
+        <arg choice="plain"><option>--help-gtk</option></arg>
+      </group>
+    </cmdsynopsis>
+  </refsynopsisdiv>
+
+  <refsection xml:id="description"><info><title>DESCRIPTION</title></info>
+    <para>This manual page documents briefly the
+      <command>&command;</command> command. It was written for the Debian
+      distribution because the original program does not have a manual
+      page.</para>
+    <para><application>&program;</application> is a LaTeX editor designed for
+      the GNOME desktop environment.</para>
+  </refsection>
+
+  <refsection xml:id="options"><info><title>OPTIONS</title></info>
+    <para>The program follows the usual GNU command line syntax,
+      with long options starting with two dashes (`-').  A summary of
+      options is included below.  For a complete description of options,
+      please use <command>&command; --help</command>.</para>
+    <variablelist>
+      <!-- Use the variablelist.term.separator and the
+           variablelist.term.break.after parameters to
+           control the term elements. -->
+      <varlistentry>
+        <term><option>-n</option></term>
+        <term><option>--new-document</option></term>
+        <listitem>
+          <para>Create a new document.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-h</option></term>
+        <term><option>--help</option></term>
+        <listitem>
+          <para>Show summary of common options.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--help-all</option></term>
+        <listitem>
+          <para>Show summary of all options.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>--help-gtk</option></term>
+        <listitem>
+          <para>Show summary of GTK+ options.</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term><option>-v</option></term>
+        <term><option>--version</option></term>
+        <listitem>
+          <para>Display version information.</para>
+        </listitem>
+      </varlistentry>
+    </variablelist>
+  </refsection>
+
+  <refsection xml:id="notes"><info><title>NOTES</title></info>
+    <para>By default, when <application>&program;</application> is started it
+      reopens the files that were open last time it was used. This behaviour
+      can be disabled in the program's preferences.</para>
+  </refsection>
+
+  <refsection xml:id="bugs"><info><title>BUGS</title></info>
+    <para>The upstreams <acronym>BTS</acronym> can be found
+      at <uri 
xlink:href="http://sourceforge.net/tracker/?group_id=271323";>http://sourceforge.net/tracker/?group_id=271323</uri>.</para>
+  </refsection>
+</refentry>
+</article>
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]