1065 lines
34 KiB
Bash
1065 lines
34 KiB
Bash
conf_print_changelog_() {
|
|
cat <<-'EOF'
|
|
hyprland-0.39.1 (0.39.1) UNRELEASED; urgency=medium
|
|
|
|
* Initial release.
|
|
|
|
-- root <root@devuan> Fri, 19 Apr 2024 07:43:43 +0100
|
|
EOF
|
|
}
|
|
# conf_print_changelog_ | tee debian/changelog
|
|
|
|
conf_print_control_() {
|
|
cat <<-'EOF'
|
|
Source: hyprland-0.39.1
|
|
Section: unknown
|
|
Priority: optional
|
|
Maintainer: root <root@devuan>
|
|
Rules-Requires-Root: no
|
|
Build-Depends:
|
|
debhelper-compat (= 13),
|
|
cmake,
|
|
Standards-Version: 4.7.0
|
|
Homepage: <insert the upstream URL, if relevant>
|
|
#Vcs-Browser: https://salsa.debian.org/debian/hyprland-0.39.1
|
|
#Vcs-Git: https://salsa.debian.org/debian/hyprland-0.39.1.git
|
|
|
|
Package: hyprland-0.39.1
|
|
Architecture: any
|
|
Multi-Arch: foreign
|
|
Depends:
|
|
${shlibs:Depends},
|
|
${misc:Depends},
|
|
Description: <insert up to 60 chars description>
|
|
<Insert long description, indented with spaces.>
|
|
EOF
|
|
}
|
|
# conf_print_control_ | tee debian/control
|
|
|
|
conf_print_copyright_() {
|
|
cat <<-'EOF'
|
|
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
|
|
Source: <url://example.com>
|
|
Upstream-Name: hyprland-0.39.1
|
|
Upstream-Contact: <preferred name and address to reach the upstream project>
|
|
|
|
Files:
|
|
*
|
|
Copyright:
|
|
<years> <put author's name and email here>
|
|
<years> <likewise for another author>
|
|
License: BSD-3-clause
|
|
|
|
Files:
|
|
debian/*
|
|
Copyright:
|
|
2024 root <root@devuan>
|
|
License: BSD-3-clause
|
|
|
|
License: BSD-3-clause
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
1. Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
2. Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in the
|
|
documentation and/or other materials provided with the distribution.
|
|
3. Neither the name of the University nor the names of its contributors
|
|
may be used to endorse or promote products derived from this software
|
|
without specific prior written permission.
|
|
.
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE HOLDERS OR
|
|
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
|
|
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
|
|
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
|
|
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
|
|
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
|
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
# Please also look if there are files or directories which have a
|
|
# different copyright/license attached and list them here.
|
|
# Please avoid picking licenses with terms that are more restrictive than the
|
|
# packaged work, as it may make Debian's contributions unacceptable upstream.
|
|
#
|
|
# If you need, there are some extra license texts available in two places:
|
|
# /usr/share/debhelper/dh_make/licenses/
|
|
# /usr/share/common-licenses/
|
|
EOF
|
|
}
|
|
# conf_print_copyright_ | tee debian/copyright
|
|
|
|
conf_print_hyprland_0_39_1_cron_d_ex_() {
|
|
cat <<-'EOF'
|
|
#
|
|
# Regular cron jobs for the hyprland-0.39.1 package.
|
|
#
|
|
0 4 * * * root [ -x /usr/bin/hyprland-0.39.1_maintenance ] && /usr/bin/hyprland-0.39.1_maintenance
|
|
EOF
|
|
}
|
|
# conf_print_hyprland_0_39_1_cron_d_ex_ | tee debian/hyprland-0.39.1.cron.d.ex
|
|
|
|
conf_print_hyprland_0_39_1_doc_base_ex_() {
|
|
cat <<-'EOF'
|
|
Document: hyprland-0.39.1
|
|
Title: Debian hyprland-0.39.1 Manual
|
|
Author: <insert document author here>
|
|
Abstract: This manual describes what hyprland-0.39.1 is
|
|
and how it can be used to
|
|
manage online manuals on Debian systems.
|
|
Section: unknown
|
|
|
|
Format: debiandoc-sgml
|
|
Files: /usr/share/doc/hyprland-0.39.1/hyprland-0.39.1.sgml.gz
|
|
|
|
Format: postscript
|
|
Files: /usr/share/doc/hyprland-0.39.1/hyprland-0.39.1.ps.gz
|
|
|
|
Format: text
|
|
Files: /usr/share/doc/hyprland-0.39.1/hyprland-0.39.1.text.gz
|
|
|
|
Format: HTML
|
|
Index: /usr/share/doc/hyprland-0.39.1/html/index.html
|
|
Files: /usr/share/doc/hyprland-0.39.1/html/*.html
|
|
EOF
|
|
}
|
|
# conf_print_hyprland_0_39_1_doc_base_ex_ | tee debian/hyprland-0.39.1.doc-base.ex
|
|
|
|
conf_print_hyprland_0_39_1_docs_docs_() {
|
|
cat <<-'EOF'
|
|
README.source
|
|
README
|
|
README.Debian
|
|
EOF
|
|
}
|
|
# conf_print_hyprland_0_39_1_docs_docs_ | tee debian/hyprland-0.39.1-docs.docs
|
|
|
|
conf_print_manpage_1_ex_() {
|
|
cat <<-'EOF'
|
|
.\" Hey, EMACS: -*- nroff -*-
|
|
.\" (C) Copyright 2024 root <root@devuan>,
|
|
.\"
|
|
.\" First parameter, NAME, should be all caps
|
|
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
|
|
.\" other parameters are allowed: see man(7), man(1)
|
|
.TH Hyprland-0.39.1 SECTION "April 19 2024"
|
|
.\" Please adjust this date whenever revising the manpage.
|
|
.\"
|
|
.\" Some roff macros, for reference:
|
|
.\" .nh disable hyphenation
|
|
.\" .hy enable hyphenation
|
|
.\" .ad l left justify
|
|
.\" .ad b justify to both left and right margins
|
|
.\" .nf disable filling
|
|
.\" .fi enable filling
|
|
.\" .br insert line break
|
|
.\" .sp <n> insert n+1 empty lines
|
|
.\" for manpage-specific macros, see man(7)
|
|
.SH NAME
|
|
hyprland-0.39.1 \- program to do something
|
|
.SH SYNOPSIS
|
|
.B hyprland-0.39.1
|
|
.RI [ options ] " files" ...
|
|
.br
|
|
.B bar
|
|
.RI [ options ] " files" ...
|
|
.SH DESCRIPTION
|
|
This manual page documents briefly the
|
|
.B hyprland-0.39.1
|
|
and
|
|
.B bar
|
|
commands.
|
|
.PP
|
|
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
|
|
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
|
|
.\" respectively.
|
|
\fBhyprland-0.39.1\fP is a program that...
|
|
.SH OPTIONS
|
|
These programs follow the usual GNU command line syntax, with long
|
|
options starting with two dashes ('\-').
|
|
A summary of options is included below.
|
|
For a complete description, see the Info files.
|
|
.TP
|
|
.B \-h, \-\-help
|
|
Show summary of options.
|
|
.TP
|
|
.B \-v, \-\-version
|
|
Show version of program.
|
|
.SH SEE ALSO
|
|
.BR bar (1),
|
|
.BR baz (1).
|
|
.br
|
|
The programs are documented fully by
|
|
.IR "The Rise and Fall of a Fooish Bar" ,
|
|
available via the Info system.
|
|
EOF
|
|
}
|
|
# conf_print_manpage_1_ex_ | tee debian/manpage.1.ex
|
|
|
|
conf_print_manpage_md_ex_() {
|
|
cat <<-'EOF'
|
|
% hyprland-0.39.1(SECTION) | User Commands
|
|
%
|
|
% "April 19 2024"
|
|
|
|
[comment]: # The lines above form a Pandoc metadata block. They must be
|
|
[comment]: # the first ones in the file.
|
|
[comment]: # See https://pandoc.org/MANUAL.html#metadata-blocks for details.
|
|
|
|
[comment]: # pandoc -s -f markdown -t man package.md -o package.1
|
|
[comment]: #
|
|
[comment]: # A manual page package.1 will be generated. You may view the
|
|
[comment]: # manual page with: nroff -man package.1 | less. A typical entry
|
|
[comment]: # in a Makefile or Makefile.am is:
|
|
[comment]: #
|
|
[comment]: # package.1: package.md
|
|
[comment]: # pandoc --standalone --from=markdown --to=man $< --output=$@
|
|
[comment]: #
|
|
[comment]: # The pandoc binary is found in the pandoc package. Please remember
|
|
[comment]: # that if you create the nroff version in one of the debian/rules
|
|
[comment]: # file targets, such as build, you will need to include pandoc in
|
|
[comment]: # your Build-Depends control field.
|
|
|
|
[comment]: # lowdown is a low dependency, lightweight alternative to
|
|
[comment]: # pandoc as a markdown to manpage translator. Use with:
|
|
[comment]: #
|
|
[comment]: # package.1: package.md
|
|
[comment]: # lowdown -s -Tman -o $@ $<
|
|
[comment]: #
|
|
[comment]: # And add lowdown to the Build-Depends control field.
|
|
|
|
[comment]: # Remove the lines starting with '[comment]:' in this file in order
|
|
[comment]: # to avoid warning messages.
|
|
|
|
# NAME
|
|
|
|
hyprland-0.39.1 - program to do something
|
|
|
|
# SYNOPSIS
|
|
|
|
**hyprland-0.39.1** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_]
|
|
[{**-e** | **\-\-example**} {_this_ | _that_}]
|
|
|
|
**hyprland-0.39.1** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}]
|
|
|
|
# DESCRIPTION
|
|
|
|
This manual page documents briefly the **hyprland-0.39.1** and **bar** commands.
|
|
|
|
This manual page was written for the Debian distribution because the
|
|
original program does not have a manual page. Instead, it has documentation
|
|
in the GNU info(1) format; see below.
|
|
|
|
**hyprland-0.39.1** is a program that...
|
|
|
|
# OPTIONS
|
|
|
|
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, see the **info**(1) files.
|
|
|
|
**-e** _this_, **\-\-example=**_that_
|
|
: Does this and that.
|
|
|
|
**-h**, **\-\-help**
|
|
: Show summary of options.
|
|
|
|
**-v**, **\-\-version**
|
|
: Show version of program.
|
|
|
|
# FILES
|
|
|
|
/etc/foo.conf
|
|
: The system-wide configuration file to control the behaviour of
|
|
hyprland-0.39.1. See **foo.conf**(5) for further details.
|
|
|
|
${HOME}/.foo.conf
|
|
: The per-user configuration file to control the behaviour of
|
|
hyprland-0.39.1. See **foo.conf**(5) for further details.
|
|
|
|
# ENVIRONMENT
|
|
|
|
**FOO_CONF**
|
|
: If used, the defined file is used as configuration file (see also
|
|
the section called “FILES”).
|
|
|
|
# DIAGNOSTICS
|
|
|
|
The following diagnostics may be issued on stderr:
|
|
|
|
Bad configuration file. Exiting.
|
|
: The configuration file seems to contain a broken configuration
|
|
line. Use the **\-\-verbose** option, to get more info.
|
|
|
|
**hyprland-0.39.1** provides some return codes, that can be used in scripts:
|
|
|
|
Code Diagnostic
|
|
0 Program exited successfully.
|
|
1 The configuration file seems to be broken.
|
|
|
|
# BUGS
|
|
|
|
The program is currently limited to only work with the foobar library.
|
|
|
|
The upstream BTS can be found at http://bugzilla.foo.tld.
|
|
|
|
# SEE ALSO
|
|
|
|
**bar**(1), **baz**(1), **foo.conf**(5)
|
|
|
|
The programs are documented fully by The Rise and Fall of a Fooish Bar
|
|
available via the **info**(1) system.
|
|
|
|
# AUTHOR
|
|
|
|
root <root@devuan>
|
|
: Wrote this manpage for the Debian system.
|
|
|
|
# COPYRIGHT
|
|
|
|
Copyright © 2007 root
|
|
|
|
This manual page was written for the Debian system (and may be used by
|
|
others).
|
|
|
|
Permission is granted to copy, distribute and/or modify this document under
|
|
the terms of the GNU General Public License, Version 2 or (at your option)
|
|
any later version published by the Free Software Foundation.
|
|
|
|
On Debian systems, the complete text of the GNU General Public License
|
|
can be found in /usr/share/common-licenses/GPL.
|
|
|
|
[comment]: # Local Variables:
|
|
[comment]: # mode: markdown
|
|
[comment]: # End:
|
|
EOF
|
|
}
|
|
# conf_print_manpage_md_ex_ | tee debian/manpage.md.ex
|
|
|
|
conf_print_manpage_sgml_ex_() {
|
|
cat <<-'EOF'
|
|
<!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
|
|
|
|
<!-- Process this file with docbook-to-man to generate an nroff manual
|
|
page: 'docbook-to-man manpage.sgml > manpage.1'. You may view
|
|
the manual page with: 'docbook-to-man manpage.sgml | nroff -man |
|
|
less'. A typical entry in a Makefile or Makefile.am is:
|
|
|
|
manpage.1: manpage.sgml
|
|
docbook-to-man $< > $@
|
|
|
|
|
|
The docbook-to-man binary is found in the docbook-to-man package.
|
|
Please remember that if you create the nroff version in one of the
|
|
debian/rules file targets (such as build), you will need to include
|
|
docbook-to-man in your Build-Depends control field.
|
|
|
|
-->
|
|
|
|
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
|
|
<!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
|
|
<!ENTITY dhsurname "<surname>SURNAME</surname>">
|
|
<!-- Please adjust the date whenever revising the manpage. -->
|
|
<!ENTITY dhdate "<date>April 19 2024</date>">
|
|
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
|
|
allowed: see man(7), man(1). -->
|
|
<!ENTITY dhsection "<manvolnum>SECTION</manvolnum>">
|
|
<!ENTITY dhemail "<email>root@devuan</email>">
|
|
<!ENTITY dhusername "root">
|
|
<!ENTITY dhucpackage "<refentrytitle>Hyprland-0.39.1</refentrytitle>">
|
|
<!ENTITY dhpackage "hyprland-0.39.1">
|
|
|
|
<!ENTITY debian "<productname>Debian</productname>">
|
|
<!ENTITY gnu "<acronym>GNU</acronym>">
|
|
<!ENTITY gpl "&gnu; <acronym>GPL</acronym>">
|
|
]>
|
|
|
|
<refentry>
|
|
<refentryinfo>
|
|
<address>
|
|
&dhemail;
|
|
</address>
|
|
<author>
|
|
&dhfirstname;
|
|
&dhsurname;
|
|
</author>
|
|
<copyright>
|
|
<year>2003</year>
|
|
<holder>&dhusername;</holder>
|
|
</copyright>
|
|
&dhdate;
|
|
</refentryinfo>
|
|
<refmeta>
|
|
&dhucpackage;
|
|
|
|
&dhsection;
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>&dhpackage;</refname>
|
|
|
|
<refpurpose>program to do something</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>&dhpackage;</command>
|
|
|
|
<arg><option>-e <replaceable>this</replaceable></option></arg>
|
|
|
|
<arg><option>--example <replaceable>that</replaceable></option></arg>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1>
|
|
<title>DESCRIPTION</title>
|
|
|
|
<para>This manual page documents briefly the
|
|
<command>&dhpackage;</command> and <command>bar</command>
|
|
commands.</para>
|
|
|
|
<para>This manual page was written for the &debian; distribution
|
|
because the original program does not have a manual page.
|
|
Instead, it has documentation in the &gnu;
|
|
<application>Info</application> format; see below.</para>
|
|
|
|
<para><command>&dhpackage;</command> is a program that...</para>
|
|
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>OPTIONS</title>
|
|
|
|
<para>These programs follow the usual &gnu; command line syntax,
|
|
with long options starting with two dashes ('-'). A summary of
|
|
options is included below. For a complete description, see the
|
|
<application>Info</application> files.</para>
|
|
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><option>-h</option>
|
|
<option>--help</option>
|
|
</term>
|
|
<listitem>
|
|
<para>Show summary of options.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>-v</option>
|
|
<option>--version</option>
|
|
</term>
|
|
<listitem>
|
|
<para>Show version of program.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>SEE ALSO</title>
|
|
|
|
<para>bar (1), baz (1).</para>
|
|
|
|
<para>The programs are documented fully by <citetitle>The Rise and
|
|
Fall of a Fooish Bar</citetitle> available via the
|
|
<application>Info</application> system.</para>
|
|
</refsect1>
|
|
<refsect1>
|
|
<title>AUTHOR</title>
|
|
|
|
<para>This manual page was written by &dhusername; &dhemail; for
|
|
the &debian; system (and may be used by others). Permission is
|
|
granted to copy, distribute and/or modify this document under
|
|
the terms of the &gnu; General Public License, Version 2 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 /usr/share/common-licenses/GPL.
|
|
</para>
|
|
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:2
|
|
sgml-indent-data:t
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:nil
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
-->
|
|
EOF
|
|
}
|
|
# conf_print_manpage_sgml_ex_ | tee debian/manpage.sgml.ex
|
|
|
|
conf_print_manpage_xml_ex_() {
|
|
cat <<-'EOF'
|
|
<?xml version='1.0' encoding='UTF-8'?>
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
|
|
|
<!--
|
|
|
|
`xsltproc -''-nonet \
|
|
-''-param man.charmap.use.subset "0" \
|
|
-''-param make.year.ranges "1" \
|
|
-''-param make.single.year.ranges "1" \
|
|
/usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
|
|
manpage.xml`
|
|
|
|
A manual page <package>.<section> will be generated. You may view the
|
|
manual page with: nroff -man <package>.<section> | less'. A typical entry
|
|
in a Makefile or Makefile.am is:
|
|
|
|
DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
|
|
XP = xsltproc -''-nonet -''-param man.charmap.use.subset "0"
|
|
|
|
manpage.1: manpage.xml
|
|
$(XP) $(DB2MAN) $<
|
|
|
|
The xsltproc binary is found in the xsltproc package. The XSL files are in
|
|
docbook-xsl. A description of the parameters you can use can be found in the
|
|
docbook-xsl-doc-* packages. Please remember that if you create the nroff
|
|
version in one of the debian/rules file targets (such as build), you will need
|
|
to include xsltproc and docbook-xsl in your Build-Depends control field.
|
|
Alternatively use the xmlto command/package. That will also automatically
|
|
pull in xsltproc and docbook-xsl.
|
|
|
|
Notes for using docbook2x: docbook2x-man does not automatically create the
|
|
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
|
|
<refsect1> ... </refsect1>.
|
|
|
|
To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
|
|
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
|
|
found in the docbook-xsl-doc-html package.
|
|
|
|
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/
|
|
|
|
-->
|
|
|
|
<!-- Fill in your name for FIRSTNAME and SURNAME. -->
|
|
<!ENTITY dhfirstname "FIRSTNAME">
|
|
<!ENTITY dhsurname "SURNAME">
|
|
<!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
|
|
<!ENTITY dhusername "root">
|
|
<!ENTITY dhemail "root@devuan">
|
|
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
|
|
allowed: see man(7), man(1) and
|
|
http://www.tldp.org/HOWTO/Man-Page/q2.html. -->
|
|
<!ENTITY dhsection "SECTION">
|
|
<!-- TITLE should be something like "User commands" or similar (see
|
|
http://www.tldp.org/HOWTO/Man-Page/q2.html). -->
|
|
<!ENTITY dhtitle "hyprland-0.39.1 User Manual">
|
|
<!ENTITY dhucpackage "Hyprland-0.39.1">
|
|
<!ENTITY dhpackage "hyprland-0.39.1">
|
|
]>
|
|
|
|
<refentry>
|
|
<refentryinfo>
|
|
<title>&dhtitle;</title>
|
|
<productname>&dhpackage;</productname>
|
|
<authorgroup>
|
|
<author>
|
|
<firstname>&dhfirstname;</firstname>
|
|
<surname>&dhsurname;</surname>
|
|
<contrib>Wrote this manpage for the Debian system.</contrib>
|
|
<address>
|
|
<email>&dhemail;</email>
|
|
</address>
|
|
</author>
|
|
</authorgroup>
|
|
<copyright>
|
|
<year>2007</year>
|
|
<holder>&dhusername;</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 2 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>
|
|
</refentryinfo>
|
|
<refmeta>
|
|
<refentrytitle>&dhucpackage;</refentrytitle>
|
|
<manvolnum>&dhsection;</manvolnum>
|
|
</refmeta>
|
|
<refnamediv>
|
|
<refname>&dhpackage;</refname>
|
|
<refpurpose>program to do something</refpurpose>
|
|
</refnamediv>
|
|
<refsynopsisdiv>
|
|
<cmdsynopsis>
|
|
<command>&dhpackage;</command>
|
|
<!-- These are several examples, how syntaxes could look -->
|
|
<arg choice="plain"><option>-e <replaceable>this</replaceable></option></arg>
|
|
<arg choice="opt"><option>--example=<parameter>that</parameter></option></arg>
|
|
<arg choice="opt">
|
|
<group choice="req">
|
|
<arg choice="plain"><option>-e</option></arg>
|
|
<arg choice="plain"><option>--example</option></arg>
|
|
</group>
|
|
<replaceable class="option">this</replaceable>
|
|
</arg>
|
|
<arg choice="opt">
|
|
<group choice="req">
|
|
<arg choice="plain"><option>-e</option></arg>
|
|
<arg choice="plain"><option>--example</option></arg>
|
|
</group>
|
|
<group choice="req">
|
|
<arg choice="plain"><replaceable>this</replaceable></arg>
|
|
<arg choice="plain"><replaceable>that</replaceable></arg>
|
|
</group>
|
|
</arg>
|
|
</cmdsynopsis>
|
|
<cmdsynopsis>
|
|
<command>&dhpackage;</command>
|
|
<!-- Normally the help and version options make the programs stop
|
|
right after outputting the requested information. -->
|
|
<group choice="opt">
|
|
<arg choice="plain">
|
|
<group choice="req">
|
|
<arg choice="plain"><option>-h</option></arg>
|
|
<arg choice="plain"><option>--help</option></arg>
|
|
</group>
|
|
</arg>
|
|
<arg choice="plain">
|
|
<group choice="req">
|
|
<arg choice="plain"><option>-v</option></arg>
|
|
<arg choice="plain"><option>--version</option></arg>
|
|
</group>
|
|
</arg>
|
|
</group>
|
|
</cmdsynopsis>
|
|
</refsynopsisdiv>
|
|
<refsect1 id="description">
|
|
<title>DESCRIPTION</title>
|
|
<para>This manual page documents briefly the
|
|
<command>&dhpackage;</command> and <command>bar</command>
|
|
commands.</para>
|
|
<para>This manual page was written for the Debian distribution
|
|
because the original program does not have a manual page.
|
|
Instead, it has documentation in the GNU <citerefentry>
|
|
<refentrytitle>info</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</citerefentry> format; see below.</para>
|
|
<para><command>&dhpackage;</command> is a program that...</para>
|
|
</refsect1>
|
|
<refsect1 id="options">
|
|
<title>OPTIONS</title>
|
|
<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, see the
|
|
<citerefentry>
|
|
<refentrytitle>info</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</citerefentry> files.</para>
|
|
<variablelist>
|
|
<!-- Use the variablelist.term.separator and the
|
|
variablelist.term.break.after parameters to
|
|
control the term elements. -->
|
|
<varlistentry>
|
|
<term><option>-e <replaceable>this</replaceable></option></term>
|
|
<term><option>--example=<replaceable>that</replaceable></option></term>
|
|
<listitem>
|
|
<para>Does this and that.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>-h</option></term>
|
|
<term><option>--help</option></term>
|
|
<listitem>
|
|
<para>Show summary of options.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><option>-v</option></term>
|
|
<term><option>--version</option></term>
|
|
<listitem>
|
|
<para>Show version of program.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="files">
|
|
<title>FILES</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><filename>/etc/foo.conf</filename></term>
|
|
<listitem>
|
|
<para>The system-wide configuration file to control the
|
|
behaviour of <application>&dhpackage;</application>. See
|
|
<citerefentry>
|
|
<refentrytitle>foo.conf</refentrytitle>
|
|
<manvolnum>5</manvolnum>
|
|
</citerefentry> for further details.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><filename>${HOME}/.foo.conf</filename></term>
|
|
<listitem>
|
|
<para>The per-user configuration file to control the
|
|
behaviour of <application>&dhpackage;</application>. See
|
|
<citerefentry>
|
|
<refentrytitle>foo.conf</refentrytitle>
|
|
<manvolnum>5</manvolnum>
|
|
</citerefentry> for further details.</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="environment">
|
|
<title>ENVIRONMENT</title>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><envar>FOO_CONF</envar></term>
|
|
<listitem>
|
|
<para>If used, the defined file is used as configuration
|
|
file (see also <xref linkend="files"/>).</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 id="diagnostics">
|
|
<title>DIAGNOSTICS</title>
|
|
<para>The following diagnostics may be issued
|
|
on <filename class="devicefile">stderr</filename>:</para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><errortext>Bad configuration file. Exiting.</errortext></term>
|
|
<listitem>
|
|
<para>The configuration file seems to contain a broken configuration
|
|
line. Use the <option>--verbose</option> option, to get more info.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
<para><command>&dhpackage;</command> provides some return codes, that can
|
|
be used in scripts:</para>
|
|
<segmentedlist>
|
|
<segtitle>Code</segtitle>
|
|
<segtitle>Diagnostic</segtitle>
|
|
<seglistitem>
|
|
<seg><errorcode>0</errorcode></seg>
|
|
<seg>Program exited successfully.</seg>
|
|
</seglistitem>
|
|
<seglistitem>
|
|
<seg><errorcode>1</errorcode></seg>
|
|
<seg>The configuration file seems to be broken.</seg>
|
|
</seglistitem>
|
|
</segmentedlist>
|
|
</refsect1>
|
|
<refsect1 id="bugs">
|
|
<!-- Or use this section to tell about upstream BTS. -->
|
|
<title>BUGS</title>
|
|
<para>The program is currently limited to only work
|
|
with the <package>foobar</package> library.</para>
|
|
<para>The upstreams <acronym>BTS</acronym> can be found
|
|
at <ulink url="http://bugzilla.foo.tld"/>.</para>
|
|
</refsect1>
|
|
<refsect1 id="see_also">
|
|
<title>SEE ALSO</title>
|
|
<!-- In alpabetical order. -->
|
|
<para><citerefentry>
|
|
<refentrytitle>bar</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</citerefentry>, <citerefentry>
|
|
<refentrytitle>baz</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</citerefentry>, <citerefentry>
|
|
<refentrytitle>foo.conf</refentrytitle>
|
|
<manvolnum>5</manvolnum>
|
|
</citerefentry></para>
|
|
<para>The programs are documented fully by <citetitle>The Rise and
|
|
Fall of a Fooish Bar</citetitle> available via the <citerefentry>
|
|
<refentrytitle>info</refentrytitle>
|
|
<manvolnum>1</manvolnum>
|
|
</citerefentry> system.</para>
|
|
</refsect1>
|
|
</refentry>
|
|
EOF
|
|
}
|
|
# conf_print_manpage_xml_ex_ | tee debian/manpage.xml.ex
|
|
|
|
conf_print_postinst_ex_() {
|
|
cat <<-'EOF'
|
|
#!/bin/sh
|
|
# postinst script for hyprland-0.39.1.
|
|
#
|
|
# See: dh_installdeb(1).
|
|
|
|
set -e
|
|
|
|
# Summary of how this script can be called:
|
|
# * <postinst> 'configure' <most-recently-configured-version>
|
|
# * <old-postinst> 'abort-upgrade' <new version>
|
|
# * <conflictor's-postinst> 'abort-remove' 'in-favour' <package>
|
|
# <new-version>
|
|
# * <postinst> 'abort-remove'
|
|
# * <deconfigured's-postinst> 'abort-deconfigure' 'in-favour'
|
|
# <failed-install-package> <version> 'removing'
|
|
# <conflicting-package> <version>
|
|
# for details, see https://www.debian.org/doc/debian-policy/ or
|
|
# the debian-policy package.
|
|
|
|
|
|
case "$1" in
|
|
configure)
|
|
;;
|
|
|
|
abort-upgrade|abort-remove|abort-deconfigure)
|
|
;;
|
|
|
|
*)
|
|
echo "postinst called with unknown argument '$1'" >&2
|
|
exit 1
|
|
;;
|
|
esac
|
|
|
|
# dh_installdeb will replace this with shell code automatically
|
|
# generated by other debhelper scripts.
|
|
|
|
#DEBHELPER#
|
|
|
|
exit 0
|
|
EOF
|
|
}
|
|
# conf_print_postinst_ex_ | tee debian/postinst.ex
|
|
|
|
conf_print_postrm_ex_() {
|
|
cat <<-'EOF'
|
|
#!/bin/sh
|
|
# postrm script for hyprland-0.39.1.
|
|
#
|
|
# See: dh_installdeb(1).
|
|
|
|
set -e
|
|
|
|
# Summary of how this script can be called:
|
|
# * <postrm> 'remove'
|
|
# * <postrm> 'purge'
|
|
# * <old-postrm> 'upgrade' <new-version>
|
|
# * <new-postrm> 'failed-upgrade' <old-version>
|
|
# * <new-postrm> 'abort-install'
|
|
# * <new-postrm> 'abort-install' <old-version>
|
|
# * <new-postrm> 'abort-upgrade' <old-version>
|
|
# * <disappearer's-postrm> 'disappear' <overwriter>
|
|
# <overwriter-version>
|
|
# for details, see https://www.debian.org/doc/debian-policy/ or
|
|
# the debian-policy package.
|
|
|
|
|
|
case "$1" in
|
|
purge|remove|upgrade|failed-upgrade|abort-install|abort-upgrade|disappear)
|
|
;;
|
|
|
|
*)
|
|
echo "postrm called with unknown argument '$1'" >&2
|
|
exit 1
|
|
;;
|
|
esac
|
|
|
|
# dh_installdeb will replace this with shell code automatically
|
|
# generated by other debhelper scripts.
|
|
|
|
#DEBHELPER#
|
|
|
|
exit 0
|
|
EOF
|
|
}
|
|
# conf_print_postrm_ex_ | tee debian/postrm.ex
|
|
|
|
conf_print_preinst_ex_() {
|
|
cat <<-'EOF'
|
|
#!/bin/sh
|
|
# preinst script for hyprland-0.39.1.
|
|
#
|
|
# See: dh_installdeb(1).
|
|
|
|
set -e
|
|
|
|
# Summary of how this script can be called:
|
|
# * <new-preinst> 'install'
|
|
# * <new-preinst> 'install' <old-version>
|
|
# * <new-preinst> 'upgrade' <old-version>
|
|
# * <old-preinst> 'abort-upgrade' <new-version>
|
|
# for details, see https://www.debian.org/doc/debian-policy/ or
|
|
# the debian-policy package.
|
|
|
|
|
|
case "$1" in
|
|
install|upgrade)
|
|
;;
|
|
|
|
abort-upgrade)
|
|
;;
|
|
|
|
*)
|
|
echo "preinst called with unknown argument '$1'" >&2
|
|
exit 1
|
|
;;
|
|
esac
|
|
|
|
# dh_installdeb will replace this with shell code automatically
|
|
# generated by other debhelper scripts.
|
|
|
|
#DEBHELPER#
|
|
|
|
exit 0
|
|
EOF
|
|
}
|
|
# conf_print_preinst_ex_ | tee debian/preinst.ex
|
|
|
|
conf_print_prerm_ex_() {
|
|
cat <<-'EOF'
|
|
#!/bin/sh
|
|
# prerm script for hyprland-0.39.1.
|
|
#
|
|
# See: dh_installdeb(1).
|
|
|
|
set -e
|
|
|
|
# Summary of how this script can be called:
|
|
# * <prerm> 'remove'
|
|
# * <old-prerm> 'upgrade' <new-version>
|
|
# * <new-prerm> 'failed-upgrade' <old-version>
|
|
# * <conflictor's-prerm> 'remove' 'in-favour' <package> <new-version>
|
|
# * <deconfigured's-prerm> 'deconfigure' 'in-favour'
|
|
# <package-being-installed> <version> 'removing'
|
|
# <conflicting-package> <version>
|
|
# for details, see https://www.debian.org/doc/debian-policy/ or
|
|
# the debian-policy package.
|
|
|
|
|
|
case "$1" in
|
|
remove|upgrade|deconfigure)
|
|
;;
|
|
|
|
failed-upgrade)
|
|
;;
|
|
|
|
*)
|
|
echo "prerm called with unknown argument '$1'" >&2
|
|
exit 1
|
|
;;
|
|
esac
|
|
|
|
# dh_installdeb will replace this with shell code automatically
|
|
# generated by other debhelper scripts.
|
|
|
|
#DEBHELPER#
|
|
|
|
exit 0
|
|
EOF
|
|
}
|
|
# conf_print_prerm_ex_ | tee debian/prerm.ex
|
|
|
|
conf_print_README_() {
|
|
cat <<-'EOF'
|
|
The Debian Package hyprland-0.39.1
|
|
----------------------------
|
|
|
|
<Comments regarding the Package.>
|
|
|
|
-- root <root@devuan> Fri, 19 Apr 2024 07:43:43 +0100
|
|
EOF
|
|
}
|
|
# conf_print_README_ | tee debian/README
|
|
|
|
conf_print_README_Debian_() {
|
|
cat <<-'EOF'
|
|
hyprland-0.39.1 for Debian
|
|
-------------------------
|
|
|
|
<Possible notes regarding this package - if none, delete this file.>
|
|
|
|
-- root <root@devuan> Fri, 19 Apr 2024 07:43:43 +0100
|
|
EOF
|
|
}
|
|
# conf_print_README_Debian_ | tee debian/README.Debian
|
|
|
|
conf_print_README_source_() {
|
|
cat <<-'EOF'
|
|
hyprland-0.39.1 for Debian
|
|
-------------------------
|
|
|
|
<This file describes information about the source package, see Debian policy
|
|
manual section 4.14. You WILL either need to modify or delete this file.>
|
|
|
|
|
|
|
|
-- root <root@devuan> Fri, 19 Apr 2024 07:43:43 +0100
|
|
EOF
|
|
}
|
|
# conf_print_README_source_ | tee debian/README.source
|
|
|
|
conf_print_rules() {
|
|
cat <<-'EOF'
|
|
#!/usr/bin/make -f
|
|
|
|
# See debhelper(7) (uncomment to enable).
|
|
# Output every command that modifies files on the build system.
|
|
#export DH_VERBOSE = 1
|
|
|
|
|
|
# See FEATURE AREAS in dpkg-buildflags(1).
|
|
#export DEB_BUILD_MAINT_OPTIONS = hardening=+all
|
|
|
|
# See ENVIRONMENT in dpkg-buildflags(1).
|
|
# Package maintainers to append CFLAGS.
|
|
#export DEB_CFLAGS_MAINT_APPEND = -Wall -pedantic
|
|
# Package maintainers to append LDFLAGS.
|
|
#export DEB_LDFLAGS_MAINT_APPEND = -Wl,--as-needed
|
|
|
|
|
|
%:
|
|
dh $@
|
|
|
|
|
|
# dh_make generated override targets.
|
|
# This is an example for Cmake (see <https://bugs.debian.org/641051>).
|
|
#override_dh_auto_configure:
|
|
# dh_auto_configure -- \
|
|
# -DCMAKE_LIBRARY_PATH=$(DEB_HOST_MULTIARCH)
|
|
EOF
|
|
}
|
|
# conf_print_rules | tee debian/rules
|
|
|
|
conf_print_salsa_ci_yml_ex_() {
|
|
cat <<-'EOF'
|
|
# For more information on what jobs are run see:
|
|
# https://salsa.debian.org/salsa-ci-team/pipeline
|
|
#
|
|
# To enable the jobs, go to your repository (at salsa.debian.org)
|
|
# and click over Settings > CI/CD > Expand (in General pipelines).
|
|
# In "CI/CD configuration file" write debian/salsa-ci.yml and click
|
|
# in "Save Changes". The CI tests will run after the next commit.
|
|
---
|
|
include:
|
|
- https://salsa.debian.org/salsa-ci-team/pipeline/raw/master/recipes/debian.yml
|
|
EOF
|
|
}
|
|
# conf_print_salsa_ci_yml_ex_ | tee debian/salsa-ci.yml.ex
|
|
|
|
conf_print_source() {
|
|
cat <<-'EOF'
|
|
|
|
EOF
|
|
}
|
|
# conf_print_source | tee debian/source
|