Package list findbugs / d154e27
add debian directory using dh_make with indenpendent binary setting yesx 8 years ago
25 changed file(s) with 1043 addition(s) and 0 deletion(s). Raw diff Collapse all Expand all
0 findbugs for Debian
1 -------------------
2
3 <possible notes regarding this package - if none, delete this file>
4
5 -- ShuxiongYe <yeshuxiong@gmail.com> Wed, 21 Aug 2013 04:07:28 +0800
0 findbugs for Debian
1 -------------------
2
3 <this file describes information about the source package, see Debian policy
4 manual section 4.14. You WILL either need to modify or delete this file>
5
6
7
8
0 findbugs (2.0.2-1) unstable; urgency=low
1
2 * Initial release (Closes: #nnnn) <nnnn is the bug number of your ITP>
3
4 -- ShuxiongYe <yeshuxiong@gmail.com> Wed, 21 Aug 2013 04:07:28 +0800
0 Source: findbugs
1 Section: unknown
2 Priority: extra
3 Maintainer: ShuxiongYe <yeshuxiong@gmail.com>
4 Build-Depends: debhelper (>= 8.0.0)
5 Standards-Version: 3.9.3
6 Homepage: <insert the upstream URL, if relevant>
7 #Vcs-Git: git://git.debian.org/collab-maint/findbugs.git
8 #Vcs-Browser: http://git.debian.org/?p=collab-maint/findbugs.git;a=summary
9
10 Package: findbugs
11 Architecture: all
12 Depends: ${misc:Depends}
13 Description: <insert up to 60 chars description>
14 <insert long description, indented with spaces>
0 Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
1 Upstream-Name: findbugs
2 Source: <url://example.com>
3
4 Files: *
5 Copyright: <years> <put author's name and email here>
6 <years> <likewise for another author>
7 License: <special license>
8 <Put the license of the package here indented by 1 space>
9 <This follows the format of Description: lines in control file>
10 .
11 <Including paragraphs>
12
13 # If you want to use GPL v2 or later for the /debian/* files use
14 # the following clauses, or change it to suit. Delete these two lines
15 Files: debian/*
16 Copyright: 2013 ShuxiongYe <yeshuxiong@gmail.com>
17 License: GPL-2+
18 This package is free software; you can redistribute it and/or modify
19 it under the terms of the GNU General Public License as published by
20 the Free Software Foundation; either version 2 of the License, or
21 (at your option) any later version.
22 .
23 This package is distributed in the hope that it will be useful,
24 but WITHOUT ANY WARRANTY; without even the implied warranty of
25 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 GNU General Public License for more details.
27 .
28 You should have received a copy of the GNU General Public License
29 along with this program. If not, see <http://www.gnu.org/licenses/>
30 .
31 On Debian systems, the complete text of the GNU General
32 Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".
33
34 # Please also look if there are files or directories which have a
35 # different copyright/license attached and list them here.
36 # Please avoid to pick license terms that are more restrictive than the
37 # packaged work, as it may make Debian's contributions unacceptable upstream.
0 README.txt
1 README.txt
2 userDict.txt
0 #! /bin/sh -e
1 # /usr/lib/emacsen-common/packages/install/findbugs
2
3 # Written by Jim Van Zandt <jrv@debian.org>, borrowing heavily
4 # from the install scripts for gettext by Santiago Vila
5 # <sanvila@ctv.es> and octave by Dirk Eddelbuettel <edd@debian.org>.
6
7 FLAVOR=$1
8 PACKAGE=findbugs
9
10 if [ ${FLAVOR} = emacs ]; then exit 0; fi
11
12 echo install/${PACKAGE}: Handling install for emacsen flavor ${FLAVOR}
13
14 #FLAVORTEST=`echo $FLAVOR | cut -c-6`
15 #if [ ${FLAVORTEST} = xemacs ] ; then
16 # SITEFLAG="-no-site-file"
17 #else
18 # SITEFLAG="--no-site-file"
19 #fi
20 FLAGS="${SITEFLAG} -q -batch -l path.el -f batch-byte-compile"
21
22 ELDIR=/usr/share/emacs/site-lisp/${PACKAGE}
23 ELCDIR=/usr/share/${FLAVOR}/site-lisp/${PACKAGE}
24 ELRELDIR=../../../emacs/site-lisp/${PACKAGE}
25
26 # Install-info-altdir does not actually exist.
27 # Maybe somebody will write it.
28 if test -x /usr/sbin/install-info-altdir; then
29 echo install/${PACKAGE}: install Info links for ${FLAVOR}
30 install-info-altdir --quiet --section "" "" --dirname=${FLAVOR} /usr/share/info/${PACKAGE}.info.gz
31 fi
32
33 install -m 755 -d ${ELCDIR}
34 cd ${ELDIR}
35 FILES=`echo *.el`
36 cd ${ELCDIR}
37 ln -sf ${ELRELDIR}/*.el .
38
39 cat << EOF > path.el
40 (debian-pkg-add-load-path-item ".")
41 (setq byte-compile-warnings nil)
42 EOF
43 ${FLAVOR} ${FLAGS} ${FILES}
44 rm -f path.el
45
46 exit 0
0 #!/bin/sh -e
1 # /usr/lib/emacsen-common/packages/remove/findbugs
2
3 FLAVOR=$1
4 PACKAGE=findbugs
5
6 if [ ${FLAVOR} != emacs ]; then
7 if test -x /usr/sbin/install-info-altdir; then
8 echo remove/${PACKAGE}: removing Info links for ${FLAVOR}
9 install-info-altdir --quiet --remove --dirname=${FLAVOR} /usr/share/info/findbugs.info.gz
10 fi
11
12 echo remove/${PACKAGE}: purging byte-compiled files for ${FLAVOR}
13 rm -rf /usr/share/${FLAVOR}/site-lisp/${PACKAGE}
14 fi
0 ;; -*-emacs-lisp-*-
1 ;;
2 ;; Emacs startup file, e.g. /etc/emacs/site-start.d/50findbugs.el
3 ;; for the Debian findbugs package
4 ;;
5 ;; Originally contributed by Nils Naumann <naumann@unileoben.ac.at>
6 ;; Modified by Dirk Eddelbuettel <edd@debian.org>
7 ;; Adapted for dh-make by Jim Van Zandt <jrv@debian.org>
8
9 ;; The findbugs package follows the Debian/GNU Linux 'emacsen' policy and
10 ;; byte-compiles its elisp files for each 'emacs flavor' (emacs19,
11 ;; xemacs19, emacs20, xemacs20...). The compiled code is then
12 ;; installed in a subdirectory of the respective site-lisp directory.
13 ;; We have to add this to the load-path:
14 (let ((package-dir (concat "/usr/share/"
15 (symbol-name debian-emacs-flavor)
16 "/site-lisp/findbugs")))
17 ;; If package-dir does not exist, the findbugs package must have
18 ;; removed but not purged, and we should skip the setup.
19 (when (file-directory-p package-dir)
20 (if (fboundp 'debian-pkg-add-load-path-item)
21 (debian-pkg-add-load-path-item package-dir)
22 (setq load-path (cons package-dir load-path)))
23 (autoload 'findbugs-mode "findbugs-mode"
24 "Major mode for editing findbugs files." t)
25 (add-to-list 'auto-mode-alist '("\\.findbugs$" . findbugs-mode))))
26
0 #
1 # Regular cron jobs for the findbugs package
2 #
3 0 4 * * * root [ -x /usr/bin/findbugs_maintenance ] && /usr/bin/findbugs_maintenance
0 # Defaults for findbugs initscript
1 # sourced by /etc/init.d/findbugs
2 # installed at /etc/default/findbugs by the maintainer scripts
3
4 #
5 # This is a POSIX shell fragment
6 #
7
8 # Additional options that are passed to the Daemon.
9 DAEMON_OPTS=""
0 Document: findbugs
1 Title: Debian findbugs Manual
2 Author: <insert document author here>
3 Abstract: This manual describes what findbugs is
4 and how it can be used to
5 manage online manuals on Debian systems.
6 Section: unknown
7
8 Format: debiandoc-sgml
9 Files: /usr/share/doc/findbugs/findbugs.sgml.gz
10
11 Format: postscript
12 Files: /usr/share/doc/findbugs/findbugs.ps.gz
13
14 Format: text
15 Files: /usr/share/doc/findbugs/findbugs.text.gz
16
17 Format: HTML
18 Index: /usr/share/doc/findbugs/html/index.html
19 Files: /usr/share/doc/findbugs/html/*.html
0 #!/bin/sh
1 ### BEGIN INIT INFO
2 # Provides: findbugs
3 # Required-Start: $network $local_fs
4 # Required-Stop:
5 # Default-Start: 2 3 4 5
6 # Default-Stop: 0 1 6
7 # Short-Description: <Enter a short description of the software>
8 # Description: <Enter a long description of the software>
9 # <...>
10 # <...>
11 ### END INIT INFO
12
13 # Author: ShuxiongYe <yeshuxiong@gmail.com>
14
15 # PATH should only include /usr/* if it runs after the mountnfs.sh script
16 PATH=/sbin:/usr/sbin:/bin:/usr/bin
17 DESC=findbugs # Introduce a short description here
18 NAME=findbugs # Introduce the short server's name here
19 DAEMON=/usr/sbin/findbugs # Introduce the server's location here
20 DAEMON_ARGS="" # Arguments to run the daemon with
21 PIDFILE=/var/run/$NAME.pid
22 SCRIPTNAME=/etc/init.d/$NAME
23
24 # Exit if the package is not installed
25 [ -x $DAEMON ] || exit 0
26
27 # Read configuration variable file if it is present
28 [ -r /etc/default/$NAME ] && . /etc/default/$NAME
29
30 # Load the VERBOSE setting and other rcS variables
31 . /lib/init/vars.sh
32
33 # Define LSB log_* functions.
34 # Depend on lsb-base (>= 3.0-6) to ensure that this file is present.
35 . /lib/lsb/init-functions
36
37 #
38 # Function that starts the daemon/service
39 #
40 do_start()
41 {
42 # Return
43 # 0 if daemon has been started
44 # 1 if daemon was already running
45 # 2 if daemon could not be started
46 start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON --test > /dev/null \
47 || return 1
48 start-stop-daemon --start --quiet --pidfile $PIDFILE --exec $DAEMON -- \
49 $DAEMON_ARGS \
50 || return 2
51 # Add code here, if necessary, that waits for the process to be ready
52 # to handle requests from services started subsequently which depend
53 # on this one. As a last resort, sleep for some time.
54 }
55
56 #
57 # Function that stops the daemon/service
58 #
59 do_stop()
60 {
61 # Return
62 # 0 if daemon has been stopped
63 # 1 if daemon was already stopped
64 # 2 if daemon could not be stopped
65 # other if a failure occurred
66 start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME
67 RETVAL="$?"
68 [ "$RETVAL" = 2 ] && return 2
69 # Wait for children to finish too if this is a daemon that forks
70 # and if the daemon is only ever run from this initscript.
71 # If the above conditions are not satisfied then add some other code
72 # that waits for the process to drop all resources that could be
73 # needed by services started subsequently. A last resort is to
74 # sleep for some time.
75 start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON
76 [ "$?" = 2 ] && return 2
77 # Many daemons don't delete their pidfiles when they exit.
78 rm -f $PIDFILE
79 return "$RETVAL"
80 }
81
82 #
83 # Function that sends a SIGHUP to the daemon/service
84 #
85 do_reload() {
86 #
87 # If the daemon can reload its configuration without
88 # restarting (for example, when it is sent a SIGHUP),
89 # then implement that here.
90 #
91 start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME
92 return 0
93 }
94
95 case "$1" in
96 start)
97 [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC " "$NAME"
98 do_start
99 case "$?" in
100 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
101 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
102 esac
103 ;;
104 stop)
105 [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME"
106 do_stop
107 case "$?" in
108 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;;
109 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;;
110 esac
111 ;;
112 status)
113 status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $?
114 ;;
115 #reload|force-reload)
116 #
117 # If do_reload() is not implemented then leave this commented out
118 # and leave 'force-reload' as an alias for 'restart'.
119 #
120 #log_daemon_msg "Reloading $DESC" "$NAME"
121 #do_reload
122 #log_end_msg $?
123 #;;
124 restart|force-reload)
125 #
126 # If the "reload" option is implemented then remove the
127 # 'force-reload' alias
128 #
129 log_daemon_msg "Restarting $DESC" "$NAME"
130 do_stop
131 case "$?" in
132 0|1)
133 do_start
134 case "$?" in
135 0) log_end_msg 0 ;;
136 1) log_end_msg 1 ;; # Old process is still running
137 *) log_end_msg 1 ;; # Failed to start
138 esac
139 ;;
140 *)
141 # Failed to stop
142 log_end_msg 1
143 ;;
144 esac
145 ;;
146 *)
147 #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2
148 echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2
149 exit 3
150 ;;
151 esac
152
153 :
0 .\" Hey, EMACS: -*- nroff -*-
1 .\" (C) Copyright 2013 ShuxiongYe <yeshuxiong@gmail.com>,
2 .\"
3 .\" First parameter, NAME, should be all caps
4 .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
5 .\" other parameters are allowed: see man(7), man(1)
6 .TH FINDBUGS SECTION "August 21, 2013"
7 .\" Please adjust this date whenever revising the manpage.
8 .\"
9 .\" Some roff macros, for reference:
10 .\" .nh disable hyphenation
11 .\" .hy enable hyphenation
12 .\" .ad l left justify
13 .\" .ad b justify to both left and right margins
14 .\" .nf disable filling
15 .\" .fi enable filling
16 .\" .br insert line break
17 .\" .sp <n> insert n+1 empty lines
18 .\" for manpage-specific macros, see man(7)
19 .SH NAME
20 findbugs \- program to do something
21 .SH SYNOPSIS
22 .B findbugs
23 .RI [ options ] " files" ...
24 .br
25 .B bar
26 .RI [ options ] " files" ...
27 .SH DESCRIPTION
28 This manual page documents briefly the
29 .B findbugs
30 and
31 .B bar
32 commands.
33 .PP
34 .\" TeX users may be more comfortable with the \fB<whatever>\fP and
35 .\" \fI<whatever>\fP escape sequences to invode bold face and italics,
36 .\" respectively.
37 \fBfindbugs\fP is a program that...
38 .SH OPTIONS
39 These programs follow the usual GNU command line syntax, with long
40 options starting with two dashes (`-').
41 A summary of options is included below.
42 For a complete description, see the Info files.
43 .TP
44 .B \-h, \-\-help
45 Show summary of options.
46 .TP
47 .B \-v, \-\-version
48 Show version of program.
49 .SH SEE ALSO
50 .BR bar (1),
51 .BR baz (1).
52 .br
53 The programs are documented fully by
54 .IR "The Rise and Fall of a Fooish Bar" ,
55 available via the Info system.
0 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
1
2 <!-- Process this file with docbook-to-man to generate an nroff manual
3 page: `docbook-to-man manpage.sgml > manpage.1'. You may view
4 the manual page with: `docbook-to-man manpage.sgml | nroff -man |
5 less'. A typical entry in a Makefile or Makefile.am is:
6
7 manpage.1: manpage.sgml
8 docbook-to-man $< > $@
9
10
11 The docbook-to-man binary is found in the docbook-to-man package.
12 Please remember that if you create the nroff version in one of the
13 debian/rules file targets (such as build), you will need to include
14 docbook-to-man in your Build-Depends control field.
15
16 -->
17
18 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
19 <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
20 <!ENTITY dhsurname "<surname>SURNAME</surname>">
21 <!-- Please adjust the date whenever revising the manpage. -->
22 <!ENTITY dhdate "<date>August 21, 2013</date>">
23 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
24 allowed: see man(7), man(1). -->
25 <!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">
26 <!ENTITY dhemail "<email>yeshuxiong@gmail.com</email>">
27 <!ENTITY dhusername "ShuxiongYe">
28 <!ENTITY dhucpackage "<refentrytitle>FINDBUGS</refentrytitle>">
29 <!ENTITY dhpackage "findbugs">
30
31 <!ENTITY debian "<productname>Debian</productname>">
32 <!ENTITY gnu "<acronym>GNU</acronym>">
33 <!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
34 ]>
35
36 <refentry>
37 <refentryinfo>
38 <address>
39 &dhemail;
40 </address>
41 <author>
42 &dhfirstname;
43 &dhsurname;
44 </author>
45 <copyright>
46 <year>2003</year>
47 <holder>&dhusername;</holder>
48 </copyright>
49 &dhdate;
50 </refentryinfo>
51 <refmeta>
52 &dhucpackage;
53
54 &dhsection;
55 </refmeta>
56 <refnamediv>
57 <refname>&dhpackage;</refname>
58
59 <refpurpose>program to do something</refpurpose>
60 </refnamediv>
61 <refsynopsisdiv>
62 <cmdsynopsis>
63 <command>&dhpackage;</command>
64
65 <arg><option>-e <replaceable>this</replaceable></option></arg>
66
67 <arg><option>--example <replaceable>that</replaceable></option></arg>
68 </cmdsynopsis>
69 </refsynopsisdiv>
70 <refsect1>
71 <title>DESCRIPTION</title>
72
73 <para>This manual page documents briefly the
74 <command>&dhpackage;</command> and <command>bar</command>
75 commands.</para>
76
77 <para>This manual page was written for the &debian; distribution
78 because the original program does not have a manual page.
79 Instead, it has documentation in the &gnu;
80 <application>Info</application> format; see below.</para>
81
82 <para><command>&dhpackage;</command> is a program that...</para>
83
84 </refsect1>
85 <refsect1>
86 <title>OPTIONS</title>
87
88 <para>These programs follow the usual &gnu; command line syntax,
89 with long options starting with two dashes (`-'). A summary of
90 options is included below. For a complete description, see the
91 <application>Info</application> files.</para>
92
93 <variablelist>
94 <varlistentry>
95 <term><option>-h</option>
96 <option>--help</option>
97 </term>
98 <listitem>
99 <para>Show summary of options.</para>
100 </listitem>
101 </varlistentry>
102 <varlistentry>
103 <term><option>-v</option>
104 <option>--version</option>
105 </term>
106 <listitem>
107 <para>Show version of program.</para>
108 </listitem>
109 </varlistentry>
110 </variablelist>
111 </refsect1>
112 <refsect1>
113 <title>SEE ALSO</title>
114
115 <para>bar (1), baz (1).</para>
116
117 <para>The programs are documented fully by <citetitle>The Rise and
118 Fall of a Fooish Bar</citetitle> available via the
119 <application>Info</application> system.</para>
120 </refsect1>
121 <refsect1>
122 <title>AUTHOR</title>
123
124 <para>This manual page was written by &dhusername; &dhemail; for
125 the &debian; system (and may be used by others). Permission is
126 granted to copy, distribute and/or modify this document under
127 the terms of the &gnu; General Public License, Version 2 any
128 later version published by the Free Software Foundation.
129 </para>
130 <para>
131 On Debian systems, the complete text of the GNU General Public
132 License can be found in /usr/share/common-licenses/GPL.
133 </para>
134
135 </refsect1>
136 </refentry>
137
138 <!-- Keep this comment at the end of the file
139 Local variables:
140 mode: sgml
141 sgml-omittag:t
142 sgml-shorttag:t
143 sgml-minimize-attributes:nil
144 sgml-always-quote-attributes:t
145 sgml-indent-step:2
146 sgml-indent-data:t
147 sgml-parent-document:nil
148 sgml-default-dtd-file:nil
149 sgml-exposed-tags:nil
150 sgml-local-catalogs:nil
151 sgml-local-ecat-files:nil
152 End:
153 -->
0 <?xml version='1.0' encoding='UTF-8'?>
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
2 "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
3
4 <!--
5
6 `xsltproc -''-nonet \
7 -''-param man.charmap.use.subset "0" \
8 -''-param make.year.ranges "1" \
9 -''-param make.single.year.ranges "1" \
10 /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
11 manpage.xml'
12
13 A manual page <package>.<section> will be generated. You may view the
14 manual page with: nroff -man <package>.<section> | less'. A typical entry
15 in a Makefile or Makefile.am is:
16
17 DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
18 XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
19
20 manpage.1: manpage.xml
21 $(XP) $(DB2MAN) $<
22
23 The xsltproc binary is found in the xsltproc package. The XSL files are in
24 docbook-xsl. A description of the parameters you can use can be found in the
25 docbook-xsl-doc-* packages. Please remember that if you create the nroff
26 version in one of the debian/rules file targets (such as build), you will need
27 to include xsltproc and docbook-xsl in your Build-Depends control field.
28 Alternatively use the xmlto command/package. That will also automatically
29 pull in xsltproc and docbook-xsl.
30
31 Notes for using docbook2x: docbook2x-man does not automatically create the
32 AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
33 <refsect1> ... </refsect1>.
34
35 To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
36 read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
37 found in the docbook-xsl-doc-html package.
38
39 Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`
40
41 General documentation about man-pages and man-page-formatting:
42 man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/
43
44 -->
45
46 <!-- Fill in your name for FIRSTNAME and SURNAME. -->
47 <!ENTITY dhfirstname "FIRSTNAME">
48 <!ENTITY dhsurname "SURNAME">
49 <!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
50 <!ENTITY dhusername "ShuxiongYe">
51 <!ENTITY dhemail "yeshuxiong@gmail.com">
52 <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
53 allowed: see man(7), man(1) and
54 http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
55 <!ENTITY dhsection "SECTION">
56 <!-- TITLE should be something like "User commands" or similar (see
57 http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
58 <!ENTITY dhtitle "findbugs User Manual">
59 <!ENTITY dhucpackage "FINDBUGS">
60 <!ENTITY dhpackage "findbugs">
61 ]>
62
63 <refentry>
64 <refentryinfo>
65 <title>&dhtitle;</title>
66 <productname>&dhpackage;</productname>
67 <authorgroup>
68 <author>
69 <firstname>&dhfirstname;</firstname>
70 <surname>&dhsurname;</surname>
71 <contrib>Wrote this manpage for the Debian system.</contrib>
72 <address>
73 <email>&dhemail;</email>
74 </address>
75 </author>
76 </authorgroup>
77 <copyright>
78 <year>2007</year>
79 <holder>&dhusername;</holder>
80 </copyright>
81 <legalnotice>
82 <para>This manual page was written for the Debian system
83 (and may be used by others).</para>
84 <para>Permission is granted to copy, distribute and/or modify this
85 document under the terms of the GNU General Public License,
86 Version 2 or (at your option) any later version published by
87 the Free Software Foundation.</para>
88 <para>On Debian systems, the complete text of the GNU General Public
89 License can be found in
90 <filename>/usr/share/common-licenses/GPL</filename>.</para>
91 </legalnotice>
92 </refentryinfo>
93 <refmeta>
94 <refentrytitle>&dhucpackage;</refentrytitle>
95 <manvolnum>&dhsection;</manvolnum>
96 </refmeta>
97 <refnamediv>
98 <refname>&dhpackage;</refname>
99 <refpurpose>program to do something</refpurpose>
100 </refnamediv>
101 <refsynopsisdiv>
102 <cmdsynopsis>
103 <command>&dhpackage;</command>
104 <!-- These are several examples, how syntaxes could look -->
105 <arg choice="plain"><option>-e <replaceable>this</replaceable></option></arg>
106 <arg choice="opt"><option>--example=<parameter>that</parameter></option></arg>
107 <arg choice="opt">
108 <group choice="req">
109 <arg choice="plain"><option>-e</option></arg>
110 <arg choice="plain"><option>--example</option></arg>
111 </group>
112 <replaceable class="option">this</replaceable>
113 </arg>
114 <arg choice="opt">
115 <group choice="req">
116 <arg choice="plain"><option>-e</option></arg>
117 <arg choice="plain"><option>--example</option></arg>
118 </group>
119 <group choice="req">
120 <arg choice="plain"><replaceable>this</replaceable></arg>
121 <arg choice="plain"><replaceable>that</replaceable></arg>
122 </group>
123 </arg>
124 </cmdsynopsis>
125 <cmdsynopsis>
126 <command>&dhpackage;</command>
127 <!-- Normally the help and version options make the programs stop
128 right after outputting the requested information. -->
129 <group choice="opt">
130 <arg choice="plain">
131 <group choice="req">
132 <arg choice="plain"><option>-h</option></arg>
133 <arg choice="plain"><option>--help</option></arg>
134 </group>
135 </arg>
136 <arg choice="plain">
137 <group choice="req">
138 <arg choice="plain"><option>-v</option></arg>
139 <arg choice="plain"><option>--version</option></arg>
140 </group>
141 </arg>
142 </group>
143 </cmdsynopsis>
144 </refsynopsisdiv>
145 <refsect1 id="description">
146 <title>DESCRIPTION</title>
147 <para>This manual page documents briefly the
148 <command>&dhpackage;</command> and <command>bar</command>
149 commands.</para>
150 <para>This manual page was written for the Debian distribution
151 because the original program does not have a manual page.
152 Instead, it has documentation in the GNU <citerefentry>
153 <refentrytitle>info</refentrytitle>
154 <manvolnum>1</manvolnum>
155 </citerefentry> format; see below.</para>
156 <para><command>&dhpackage;</command> is a program that...</para>
157 </refsect1>
158 <refsect1 id="options">
159 <title>OPTIONS</title>
160 <para>The program follows the usual GNU command line syntax,
161 with long options starting with two dashes (`-'). A summary of
162 options is included below. For a complete description, see the
163 <citerefentry>
164 <refentrytitle>info</refentrytitle>
165 <manvolnum>1</manvolnum>
166 </citerefentry> files.</para>
167 <variablelist>
168 <!-- Use the variablelist.term.separator and the
169 variablelist.term.break.after parameters to
170 control the term elements. -->
171 <varlistentry>
172 <term><option>-e <replaceable>this</replaceable></option></term>
173 <term><option>--example=<replaceable>that</replaceable></option></term>
174 <listitem>
175 <para>Does this and that.</para>
176 </listitem>
177 </varlistentry>
178 <varlistentry>
179 <term><option>-h</option></term>
180 <term><option>--help</option></term>
181 <listitem>
182 <para>Show summary of options.</para>
183 </listitem>
184 </varlistentry>
185 <varlistentry>
186 <term><option>-v</option></term>
187 <term><option>--version</option></term>
188 <listitem>
189 <para>Show version of program.</para>
190 </listitem>
191 </varlistentry>
192 </variablelist>
193 </refsect1>
194 <refsect1 id="files">
195 <title>FILES</title>
196 <variablelist>
197 <varlistentry>
198 <term><filename>/etc/foo.conf</filename></term>
199 <listitem>
200 <para>The system-wide configuration file to control the
201 behaviour of <application>&dhpackage;</application>. See
202 <citerefentry>
203 <refentrytitle>foo.conf</refentrytitle>
204 <manvolnum>5</manvolnum>
205 </citerefentry> for further details.</para>
206 </listitem>
207 </varlistentry>
208 <varlistentry>
209 <term><filename>${HOME}/.foo.conf</filename></term>
210 <listitem>
211 <para>The per-user configuration file to control the
212 behaviour of <application>&dhpackage;</application>. See
213 <citerefentry>
214 <refentrytitle>foo.conf</refentrytitle>
215 <manvolnum>5</manvolnum>
216 </citerefentry> for further details.</para>
217 </listitem>
218 </varlistentry>
219 </variablelist>
220 </refsect1>
221 <refsect1 id="environment">
222 <title>ENVIRONMENT</title>
223 <variablelist>
224 <varlistentry>
225 <term><envar>FOO_CONF</envar></term>
226 <listitem>
227 <para>If used, the defined file is used as configuration
228 file (see also <xref linkend="files"/>).</para>
229 </listitem>
230 </varlistentry>
231 </variablelist>
232 </refsect1>
233 <refsect1 id="diagnostics">
234 <title>DIAGNOSTICS</title>
235 <para>The following diagnostics may be issued
236 on <filename class="devicefile">stderr</filename>:</para>
237 <variablelist>
238 <varlistentry>
239 <term><errortext>Bad configuration file. Exiting.</errortext></term>
240 <listitem>
241 <para>The configuration file seems to contain a broken configuration
242 line. Use the <option>--verbose</option> option, to get more info.
243 </para>
244 </listitem>
245 </varlistentry>
246 </variablelist>
247 <para><command>&dhpackage;</command> provides some return codes, that can
248 be used in scripts:</para>
249 <segmentedlist>
250 <segtitle>Code</segtitle>
251 <segtitle>Diagnostic</segtitle>
252 <seglistitem>
253 <seg><errorcode>0</errorcode></seg>
254 <seg>Program exited successfully.</seg>
255 </seglistitem>
256 <seglistitem>
257 <seg><errorcode>1</errorcode></seg>
258 <seg>The configuration file seems to be broken.</seg>
259 </seglistitem>
260 </segmentedlist>
261 </refsect1>
262 <refsect1 id="bugs">
263 <!-- Or use this section to tell about upstream BTS. -->
264 <title>BUGS</title>
265 <para>The program is currently limited to only work
266 with the <package>foobar</package> library.</para>
267 <para>The upstreams <acronym>BTS</acronym> can be found
268 at <ulink url="http://bugzilla.foo.tld"/>.</para>
269 </refsect1>
270 <refsect1 id="see_also">
271 <title>SEE ALSO</title>
272 <!-- In alpabetical order. -->
273 <para><citerefentry>
274 <refentrytitle>bar</refentrytitle>
275 <manvolnum>1</manvolnum>
276 </citerefentry>, <citerefentry>
277 <refentrytitle>baz</refentrytitle>
278 <manvolnum>1</manvolnum>
279 </citerefentry>, <citerefentry>
280 <refentrytitle>foo.conf</refentrytitle>
281 <manvolnum>5</manvolnum>
282 </citerefentry></para>
283 <para>The programs are documented fully by <citetitle>The Rise and
284 Fall of a Fooish Bar</citetitle> available via the <citerefentry>
285 <refentrytitle>info</refentrytitle>
286 <manvolnum>1</manvolnum>
287 </citerefentry> system.</para>
288 </refsect1>
289 </refentry>
290
0 ?package(findbugs):needs="X11|text|vc|wm" section="Applications/see-menu-manual"\
1 title="findbugs" command="/usr/bin/findbugs"
0 #!/bin/sh
1 # postinst script for findbugs
2 #
3 # see: dh_installdeb(1)
4
5 set -e
6
7 # summary of how this script can be called:
8 # * <postinst> `configure' <most-recently-configured-version>
9 # * <old-postinst> `abort-upgrade' <new version>
10 # * <conflictor's-postinst> `abort-remove' `in-favour' <package>
11 # <new-version>
12 # * <postinst> `abort-remove'
13 # * <deconfigured's-postinst> `abort-deconfigure' `in-favour'
14 # <failed-install-package> <version> `removing'
15 # <conflicting-package> <version>
16 # for details, see http://www.debian.org/doc/debian-policy/ or
17 # the debian-policy package
18
19
20 case "$1" in
21 configure)
22 ;;
23
24 abort-upgrade|abort-remove|abort-deconfigure)
25 ;;
26
27 *)
28 echo "postinst called with unknown argument \`$1'" >&2
29 exit 1
30 ;;
31 esac
32
33 # dh_installdeb will replace this with shell code automatically
34 # generated by other debhelper scripts.
35
36 #DEBHELPER#
37
38 exit 0
0 #!/bin/sh
1 # postrm script for findbugs
2 #
3 # see: dh_installdeb(1)
4
5 set -e
6
7 # summary of how this script can be called:
8 # * <postrm> `remove'
9 # * <postrm> `purge'
10 # * <old-postrm> `upgrade' <new-version>
11 # * <new-postrm> `failed-upgrade' <old-version>
12 # * <new-postrm> `abort-install'
13 # * <new-postrm> `abort-install' <old-version>
14 # * <new-postrm> `abort-upgrade' <old-version>
15 # * <disappearer's-postrm> `disappear' <overwriter>
16 # <overwriter-version>
17 # for details, see http://www.debian.org/doc/debian-policy/ or
18 # the debian-policy package
19
20
21 case "$1" in
22 purge|remove|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear)
23 ;;
24
25 *)
26 echo "postrm called with unknown argument \`$1'" >&2
27 exit 1
28 ;;
29 esac
30
31 # dh_installdeb will replace this with shell code automatically
32 # generated by other debhelper scripts.
33
34 #DEBHELPER#
35
36 exit 0
0 #!/bin/sh
1 # preinst script for findbugs
2 #
3 # see: dh_installdeb(1)
4
5 set -e
6
7 # summary of how this script can be called:
8 # * <new-preinst> `install'
9 # * <new-preinst> `install' <old-version>
10 # * <new-preinst> `upgrade' <old-version>
11 # * <old-preinst> `abort-upgrade' <new-version>
12 # for details, see http://www.debian.org/doc/debian-policy/ or
13 # the debian-policy package
14
15
16 case "$1" in
17 install|upgrade)
18 ;;
19
20 abort-upgrade)
21 ;;
22
23 *)
24 echo "preinst called with unknown argument \`$1'" >&2
25 exit 1
26 ;;
27 esac
28
29 # dh_installdeb will replace this with shell code automatically
30 # generated by other debhelper scripts.
31
32 #DEBHELPER#
33
34 exit 0
0 #!/bin/sh
1 # prerm script for findbugs
2 #
3 # see: dh_installdeb(1)
4
5 set -e
6
7 # summary of how this script can be called:
8 # * <prerm> `remove'
9 # * <old-prerm> `upgrade' <new-version>
10 # * <new-prerm> `failed-upgrade' <old-version>
11 # * <conflictor's-prerm> `remove' `in-favour' <package> <new-version>
12 # * <deconfigured's-prerm> `deconfigure' `in-favour'
13 # <package-being-installed> <version> `removing'
14 # <conflicting-package> <version>
15 # for details, see http://www.debian.org/doc/debian-policy/ or
16 # the debian-policy package
17
18
19 case "$1" in
20 remove|upgrade|deconfigure)
21 ;;
22
23 failed-upgrade)
24 ;;
25
26 *)
27 echo "prerm called with unknown argument \`$1'" >&2
28 exit 1
29 ;;
30 esac
31
32 # dh_installdeb will replace this with shell code automatically
33 # generated by other debhelper scripts.
34
35 #DEBHELPER#
36
37 exit 0
0 #!/usr/bin/make -f
1 # -*- makefile -*-
2 # Sample debian/rules that uses debhelper.
3 # This file was originally written by Joey Hess and Craig Small.
4 # As a special exception, when this file is copied by dh-make into a
5 # dh-make output file, you may use that output file without restriction.
6 # This special exception was added by Craig Small in version 0.37 of dh-make.
7
8 # Uncomment this to turn on verbose mode.
9 #export DH_VERBOSE=1
10
11 %:
12 dh $@
0 3.0 (quilt)
0 # Example watch control file for uscan
1 # Rename this file to "watch" and then you can run the "uscan" command
2 # to check for upstream updates and more.
3 # See uscan(1) for format
4
5 # Compulsory line, this is a version 3 file
6 version=3
7
8 # Uncomment to examine a Webpage
9 # <Webpage URL> <string match>
10 #http://www.example.com/downloads.php findbugs-(.*)\.tar\.gz
11
12 # Uncomment to examine a Webserver directory
13 #http://www.example.com/pub/findbugs-(.*)\.tar\.gz
14
15 # Uncommment to examine a FTP server
16 #ftp://ftp.example.com/pub/findbugs-(.*)\.tar\.gz debian uupdate
17
18 # Uncomment to find new files on sourceforge, for devscripts >= 2.9
19 # http://sf.net/findbugs/findbugs-(.*)\.tar\.gz
20
21 # Uncomment to find new files on GooglePages
22 # http://example.googlepages.com/foo.html findbugs-(.*)\.tar\.gz