Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

debianization of libaml0, libaml-dev #7

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
@@ -1,2 +1,6 @@
build*
.ycm_extra_conf.py
debian/tmp
debian/.debhelper
debian/libaml0
debian/libaml-dev
6 changes: 6 additions & 0 deletions debian/README.Debian
@@ -0,0 +1,6 @@
libaml for Debian
----------------

<possible notes regarding this package - if none, delete this file>

-- jauntywunderkind <jaunty@voodoowarez.com> Mon, 11 Oct 2021 01:47:55 -0400
10 changes: 10 additions & 0 deletions debian/README.source
@@ -0,0 +1,10 @@
libaml 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>



-- jauntywunderkind <jaunty@voodoowarez.com> Mon, 11 Oct 2021 01:47:55 -0400

5 changes: 5 additions & 0 deletions debian/changelog
@@ -0,0 +1,5 @@
libaml (0.2.0-1) UNRELEASED; urgency=medium

* Initial release (Closes: #nnnn) <nnnn is the bug number of your ITP>

-- jauntywunderkind <jaunty@voodoowarez.com> Mon, 11 Oct 2021 01:47:55 -0400
25 changes: 25 additions & 0 deletions debian/control
@@ -0,0 +1,25 @@
Source: libaml
Priority: optional
Maintainer: jauntywunderkind <jaunty@voodoowarez.com>
Build-Depends: debhelper-compat (= 13)
Standards-Version: 4.6.0
Section: libs
Homepage: https://github.com/any1/aml
Vcs-Browser: https://github.com/any1/aml
Vcs-Git: https://github.com/any1/aml.git
Rules-Requires-Root: no

Package: libaml-dev
Section: libdevel
Architecture: any
Multi-Arch: same
Depends: libaml0 (= ${binary:Version}), ${misc:Depends}
Description: Another Main Loop event loop library (development files)
A simple portable main loop library with a variety of capabilities.

Package: libaml0
Architecture: any
Multi-Arch: same
Depends: ${shlibs:Depends}, ${misc:Depends}
Description: Another Main Loop event loop library
A simple portable main loop library with a variety of capabilities.
24 changes: 24 additions & 0 deletions debian/copyright
@@ -0,0 +1,24 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: libaml
Upstream-Contact: Andri Yngvason <andri@yngvason.is>
Source: https://github.com/any1/aml

Files: *
Copyright: 2020 Andri Yngvason <andri@yngvason.is>
License: ISC
Permission to use, copy, modify, and/or distribute this software for any purpose
with or without fee is hereby granted, provided that the above copyright notice
and this permission notice appear in all copies.
.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.

<Put the license of the package here indented by 1 space>
<This follows the format of Description: lines in control file>
.
<Including paragraphs>
2 changes: 2 additions & 0 deletions debian/debhelper-build-stamp
@@ -0,0 +1,2 @@
libaml-dev
libaml0
4 changes: 4 additions & 0 deletions debian/files
@@ -0,0 +1,4 @@
libaml-dev_0.2.0-1_amd64.deb libdevel optional
libaml0-dbgsym_0.2.0-1_amd64.deb debug optional automatic=yes
libaml0_0.2.0-1_amd64.deb libs optional
libaml_0.2.0-1_amd64.buildinfo libs optional
2 changes: 2 additions & 0 deletions debian/libaml-dev.dirs
@@ -0,0 +1,2 @@
usr/lib
usr/include
3 changes: 3 additions & 0 deletions debian/libaml-dev.install
@@ -0,0 +1,3 @@
usr/include/*
usr/lib/*/lib*.so
usr/lib/*/pkgconfig/*
2 changes: 2 additions & 0 deletions debian/libaml-dev.substvars
@@ -0,0 +1,2 @@
misc:Depends=
misc:Pre-Depends=
2 changes: 2 additions & 0 deletions debian/libaml-docs.docs
@@ -0,0 +1,2 @@
README.Debian
README.source
4 changes: 4 additions & 0 deletions debian/libaml.cron.d.ex
@@ -0,0 +1,4 @@
#
# Regular cron jobs for the libaml package
#
0 4 * * * root [ -x /usr/bin/libaml_maintenance ] && /usr/bin/libaml_maintenance
20 changes: 20 additions & 0 deletions debian/libaml.doc-base.ex
@@ -0,0 +1,20 @@
Document: libaml
Title: Debian libaml Manual
Author: <insert document author here>
Abstract: This manual describes what libaml is
and how it can be used to
manage online manuals on Debian systems.
Section: unknown

Format: debiandoc-sgml
Files: /usr/share/doc/libaml/libaml.sgml.gz

Format: postscript
Files: /usr/share/doc/libaml/libaml.ps.gz

Format: text
Files: /usr/share/doc/libaml/libaml.text.gz

Format: HTML
Index: /usr/share/doc/libaml/html/index.html
Files: /usr/share/doc/libaml/html/*.html
1 change: 1 addition & 0 deletions debian/libaml0.dirs
@@ -0,0 +1 @@
usr/lib
1 change: 1 addition & 0 deletions debian/libaml0.install
@@ -0,0 +1 @@
usr/lib/*/lib*.so.*
3 changes: 3 additions & 0 deletions debian/libaml0.substvars
@@ -0,0 +1,3 @@
shlibs:Depends=libc6 (>= 2.32)
misc:Depends=
misc:Pre-Depends=
56 changes: 56 additions & 0 deletions debian/manpage.1.ex
@@ -0,0 +1,56 @@
.\" Hey, EMACS: -*- nroff -*-
.\" (C) Copyright 2021 jauntywunderkind <jaunty@voodoowarez.com>,
.\"
.\" 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 Libaml SECTION "October 11 2021"
.\" 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
libaml \- program to do something
.SH SYNOPSIS
.B libaml
.RI [ options ] " files" ...
.br
.B bar
.RI [ options ] " files" ...
.SH DESCRIPTION
This manual page documents briefly the
.B libaml
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.
\fBlibaml\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.
126 changes: 126 additions & 0 deletions debian/manpage.md.ex
@@ -0,0 +1,126 @@
% libaml(SECTION) | User Commands
%
% "October 11 2021"

[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]: # Remove the lines starting with `[comment]:' in this file in order
[comment]: # to avoid warning messages from pandoc.

# NAME

libaml - program to do something

# SYNOPSIS

**libaml** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_]
[{**-e** | **\-\-example**} {_this_ | _that_}]

**libaml** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}]

# DESCRIPTION

This manual page documents briefly the **libaml** 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.

**libaml** 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
libaml. See **foo.conf**(5) for further details.

${HOME}/.foo.conf
: The per-user configuration file to control the behaviour of
libaml. 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.

**libaml** 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

jauntywunderkind <jaunty@voodoowarez.com>
: Wrote this manpage for the Debian system.

# COPYRIGHT

Copyright © 2007 jauntywunderkind

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: