[esorex] 01/01: Remove generated status line from manpage; move Hinte to the end

Tue Mar 10 13:27:45 UTC 2015

This is an automated email from the git hooks/post-receive script.

olebole pushed a commit to branch debian
in repository esorex.

commit 733ea794178465c1382633efba079c0098d1b954
Author: Ole Streicher <debian at liska.ath.cx>
Date:   Tue Mar 10 14:28:07 2015 +0100

    Remove generated status line from manpage; move Hinte to the end
---
 debian/patches/generate-manpage.patch | 85 ++++++++++++++++++-----------------
 1 file changed, 43 insertions(+), 42 deletions(-)

diff --git a/debian/patches/generate-manpage.patch b/debian/patches/generate-manpage.patch
index 017eb2c..fbec856 100644
--- a/debian/patches/generate-manpage.patch
+++ b/debian/patches/generate-manpage.patch
@@ -12,18 +12,18 @@ Subject: Generate a manpage for esorex.
 +man1_MANS = esorex.man
 --- /dev/null
 +++ b/src/esorex_create_man.sh
-@@ -0,0 +1,108 @@
+@@ -0,0 +1,109 @@
 +#!/bin/sh
 +
-+help2man -N -i $0  ./esorex | sed s/^:\ // | fgrep -v "***" > esorex.man
-+<< instrument.
++help2man -N -i $0  esorex | sed s/^:\ // | fgrep -v "Libraries used: CPL =" | fgrep -v "***" > esorex.man
++<< displayed.
 +
 +[NAME]
 +esorex \- ESO Recipe Execution Tool
 +
 +[DESCRIPTION]
 +EsoRex is the ESO Recipe Execution Tool. It can list, configure and execute
-+CPL-based recipes from the command line. 
++CPL-based recipes from the command line.
 +
 +One of the features provided by the CPL is the ability to create
 +data-reduction algorithms that run as plugins (dynamic libraries). These are
@@ -33,47 +33,13 @@ Subject: Generate a manpage for esorex.
 +As these recipes are dynamic libraries, it is not possible to run them
 +directly from the command line. However, ESO provides several tools to do
 +this, thus saving recipe developers the need to write such an application
-+themselves. One of these is GASGANO (a GUI-based tool) and the other is 
-+ EsoRex (which runs from the command line) and is described here.  
++themselves. One of these is GASGANO (a GUI-based tool) and the other is
++EsoRex (which runs from the command line) and is described here.
 +
 +[ENVIRONMENT]
 +All options can be set as environment parameters as well. See the previous
 +paragraph for details.
 +
-+[HINTS]
-+.TP
-+.SH File permissions
-+When a recipe is used with the \fB\-\-suppress\-prefix\fR option, and the 
-+\fB\-\-output\-dir\fR is set to the current working directory, then the first
-+execution of a recipe will work correctly, but subsequent executions may 
-+fail. This is due to output products being given \`read-only\' permission 
-+(to avoid the potential inadvertant loss of products). The recipe itself 
-+is unable to modify the permissions, and thus it fails when attempting to 
-+create the file. The solution (other than using a different output directory
-+or prefixes) is to change the permission of these output files or delete 
-+them prior to any subsequent execution of that recipe. 
-+
-+This problem is less likely to occur in EsoRex v2+, due to the replacement of
-+the \fB\-\-output\-overwrite\fR option with the \fB\-\-output\-readonly\fR 
-+(which is disabled by default). However, a determined user can still reach 
-+this situation, in which case the non-readable products must have their 
-+permissions changed, as described above.
-+
-+.TP
-+.SH Configuration files
-+When creating configuration files, if the the recipe is provided on the
-+command line, then EsoRex will generate the configuration file for this
-+recipe. If no recipe name is given, then EsoRex will generate a configuration
-+file for EsoRex itself. All configuration files are written in the
-+$HOME/.esorex/ directory.
-+
-+.TP
-+.SH Memory checking
-+It is possible to get EsoRex to check for memory leaks in the recipe
-+that it is running, by enabling the \fB\-\-mem\-check\fR option. Then, at the
-+conclusion of the recipe execution, and after memory deallocation, a list of
-+all remaining allocated memory will be printed to screen. If there are no
-+memory leaks, then no addition output is displayed.
 +
 +[FILES]
 +.TP
@@ -118,6 +84,41 @@ Subject: Generate a manpage for esorex.
 + /data/gasgano/extract_table2.fits       EXTRACT_TABLE
 + /data/cal/badpixel.3.tfits              CCD_TABLE
 +
-+For an concrete example for a specific instrument, check the documentation for that
-+instrument.
++For an concrete example for a specific instrument, check the
++documentation for that instrument.
 +
++.SH HINTS
++.TP
++.SH File permissions
++When a recipe is used with the \fB\-\-suppress\-prefix\fR option, and the
++\fB\-\-output\-dir\fR is set to the current working directory, then the first
++execution of a recipe will work correctly, but subsequent executions may
++fail. This is due to output products being given \`read-only\' permission
++(to avoid the potential inadvertant loss of products). The recipe itself
++is unable to modify the permissions, and thus it fails when attempting to
++create the file. The solution (other than using a different output directory
++or prefixes) is to change the permission of these output files or delete
++them prior to any subsequent execution of that recipe.
++
++This problem is less likely to occur in EsoRex v2+, due to the replacement of
++the \fB\-\-output\-overwrite\fR option with the \fB\-\-output\-readonly\fR
++(which is disabled by default). However, a determined user can still reach
++this situation, in which case the non-readable products must have their
++permissions changed, as described above.
++
++.TP
++.SH Configuration files
++When creating configuration files, if the the recipe is provided on the
++command line, then EsoRex will generate the configuration file for this
++recipe. If no recipe name is given, then EsoRex will generate a configuration
++file for EsoRex itself. All configuration files are written in the
++$HOME/.esorex/ directory.
++
++.TP
++.SH Memory checking
++It is possible to get EsoRex to check for memory leaks in the recipe
++that it is running, by enabling the \fB\-\-mem\-check\fR option. Then, at the
++conclusion of the recipe execution, and after memory deallocation, a list of
++all remaining allocated memory will be printed to screen. If there are no
++memory leaks, then no addition output is
++displayed.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-astro/packages/esorex.git

