From b2cecaeec1dd5f384955486e83e3fb644069dda1 Mon Sep 17 00:00:00 2001 From: Olivier Langella <olivier.langella@u-psud.fr> Date: Fri, 6 Nov 2020 16:00:06 +0100 Subject: [PATCH] docbook file to generate UNIX manpage --- doc/xtpcpp.xml | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 doc/xtpcpp.xml diff --git a/doc/xtpcpp.xml b/doc/xtpcpp.xml new file mode 100644 index 00000000..4a1a5a8e --- /dev/null +++ b/doc/xtpcpp.xml @@ -0,0 +1,96 @@ +<?xml version="1.0"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" +[ +<!ENTITY progname "xtpcpp"> +<!ENTITY progName "xtpcpp"> +]> + +<refentry> + + <refentryinfo> + <date>2020 november 6</date> + </refentryinfo> + + <refmeta> + <refentrytitle> + <application>&progName;</application> + </refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo>&progName; proteomic software for peptides and proteins identification and quantification</refmiscinfo> + </refmeta> + + <refnamediv> + <refname> + <application>&progName;</application> + </refname> + + <refpurpose> + Open xtpcpp project file (.xpip extensions) + </refpurpose> + </refnamediv> + + <refsynopsisdiv> + + <cmdsynopsis> + <command>&progname;</command> + <arg><option><replaceable class="parameter">options</replaceable></option></arg> + <arg><option><replaceable class="parameter">filename ...</replaceable></option></arg> + </cmdsynopsis> + + </refsynopsisdiv> + + <refsect1> + <title>DESCRIPTION</title> + <para> + + This manual page documents briefly the <command>&progName;</command>Â software. + + This program can be used to load MS/MS identification engine results. It includes + peptide filtering, grouping algorithms, data visualization, peptide quantification using XICs. + + </para> + + </refsect1> + + <refsect1> + <title>OPTIONS</title> + <variablelist> + + <varlistentry> + <term><option>-h | --help</option></term> + <listitem> + <para> + Displays detailed usage information and exits. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>-v | --version</option></term> + <listitem> + <para> + Print the version of the software program. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><replaceable class="parameter">filename</replaceable></term> + <listitem> + <para> + X!TandemPipeline project file to be opened. + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title>Bibliographic reference to be cited</title> + <para> + Langella O, Valot B, Balliau T, Blein-Nicolas M, Bonhomme L, Zivy M. (2017) X!TandemPipeline: A Tool to Manage Sequence Redundancy for Protein Inference and Phosphosite Identification. J. Proteome Res., 2 (16) 494-503 + </para> + </refsect1> +</refentry> + -- GitLab