diff --git a/debian/README.Debian b/debian/README.Debian new file mode 100644 index 0000000..25ce732 --- /dev/null +++ b/debian/README.Debian @@ -0,0 +1,6 @@ +blag for Debian +-------------- + + + + -- Bastian Venthur Sun, 05 Jun 2022 15:20:48 +0200 diff --git a/debian/changelog b/debian/changelog new file mode 100644 index 0000000..0392ef6 --- /dev/null +++ b/debian/changelog @@ -0,0 +1,5 @@ +blag (1.2) unstable; urgency=medium + + * Initial release. + + -- Bastian Venthur Sun, 05 Jun 2022 15:20:48 +0200 diff --git a/debian/control b/debian/control new file mode 100644 index 0000000..91ef338 --- /dev/null +++ b/debian/control @@ -0,0 +1,57 @@ +Source: blag +Section: python +Priority: optional +Maintainer: Bastian Venthur +Rules-Requires-Root: no +Build-Depends: + debhelper-compat (= 13), + dh-sequence-python3, + dh-python, + python3-setuptools, + python3-all, + python3-markdown, + python3-feedgenerator, + python3-jinja2, + python3-pygments, + python3-pytest, + python3-pytest-cov, +#Testsuite: autopkgtest-pkg-python +Standards-Version: 4.6.0.1 +Homepage: https://github.com/venthur/blag +Vcs-Browser: https://github.com/venthur/blag +Vcs-Git: https://github.com/venthur/blag.git + +Package: blag +Architecture: all +Depends: + ${python3:Depends}, + ${misc:Depends}, +Suggests: + python-blag-doc, +Description: Blog-aware, static site generator + Blag is a blog-aware, static site generator, written in Python. It supports + the following features: + * Write content in Markdown + * Theming support using Jinja2 templates + * Generation of Atom feeds for blog content + * Fenced code blocks and syntax highlighting using Pygments + * Integrated devserver + * Available on PyPI + +#Package: blag-doc +#Section: doc +#Architecture: all +#Depends: +# ${sphinxdoc:Depends}, +# ${misc:Depends}, +#Description: Blog-aware, static site generator (documentation) +# Blag is a blog-aware, static site generator, written in Python. It supports +# the following features: +# * Write content in Markdown +# * Theming support using Jinja2 templates +# * Generation of Atom feeds for blog content +# * Fenced code blocks and syntax highlighting using Pygments +# * Integrated devserver +# * Available on PyPI +# . +# This is the common documentation package. diff --git a/debian/copyright b/debian/copyright new file mode 100644 index 0000000..0955977 --- /dev/null +++ b/debian/copyright @@ -0,0 +1,35 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Source: https://github.com/venthur/blag +Upstream-Name: blag +Upstream-Contact: Bastian Venthur venthur@debian.org + +Files: + * +Copyright: + 2022 Bastian Venthur venthur@debian.org +License: MIT + +Files: + debian/* +Copyright: + 2022 Bastian Venthur +License: MIT + +License: MIT + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to deal + in the Software without restriction, including without limitation the rights + to use, copy, modify, merge, publish, distribute, sublicense, and/or sell + copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + . + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + . + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE + SOFTWARE. diff --git a/debian/manpage.1.ex b/debian/manpage.1.ex new file mode 100644 index 0000000..c2dbdcc --- /dev/null +++ b/debian/manpage.1.ex @@ -0,0 +1,56 @@ +.\" Hey, EMACS: -*- nroff -*- +.\" (C) Copyright 2022 Bastian Venthur , +.\" +.\" 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 Blag SECTION "June 5 2022" +.\" 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 insert n+1 empty lines +.\" for manpage-specific macros, see man(7) +.SH NAME +blag \- program to do something +.SH SYNOPSIS +.B blag +.RI [ options ] " files" ... +.br +.B bar +.RI [ options ] " files" ... +.SH DESCRIPTION +This manual page documents briefly the +.B blag +and +.B bar +commands. +.PP +.\" TeX users may be more comfortable with the \fB\fP and +.\" \fI\fP escape sequences to invode bold face and italics, +.\" respectively. +\fBblag\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. diff --git a/debian/manpage.md.ex b/debian/manpage.md.ex new file mode 100644 index 0000000..6b008b9 --- /dev/null +++ b/debian/manpage.md.ex @@ -0,0 +1,126 @@ +% blag(SECTION) | User Commands +% +% "June 5 2022" + +[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 + +blag - program to do something + +# SYNOPSIS + +**blag** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_] + [{**-e** | **\-\-example**} {_this_ | _that_}] + +**blag** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}] + +# DESCRIPTION + +This manual page documents briefly the **blag** 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. + +**blag** 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 + blag. See **foo.conf**(5) for further details. + +${HOME}/.foo.conf +: The per-user configuration file to control the behaviour of + blag. 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. + +**blag** 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 + +Bastian Venthur +: Wrote this manpage for the Debian system. + +# COPYRIGHT + +Copyright © 2007 Bastian Venthur + +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: diff --git a/debian/package.doc-base.ex b/debian/package.doc-base.ex new file mode 100644 index 0000000..522a242 --- /dev/null +++ b/debian/package.doc-base.ex @@ -0,0 +1,20 @@ +Document: blag +Title: Debian blag Manual +Author: +Abstract: This manual describes what blag is + and how it can be used to + manage online manuals on Debian systems. +Section: unknown + +Format: debiandoc-sgml +Files: /usr/share/doc/blag/blag.sgml.gz + +Format: postscript +Files: /usr/share/doc/blag/blag.ps.gz + +Format: text +Files: /usr/share/doc/blag/blag.text.gz + +Format: HTML +Index: /usr/share/doc/blag/html/index.html +Files: /usr/share/doc/blag/html/*.html diff --git a/debian/rules b/debian/rules new file mode 100755 index 0000000..ffb6044 --- /dev/null +++ b/debian/rules @@ -0,0 +1,25 @@ +#!/usr/bin/make -f + +# See debhelper(7) (uncomment to enable). +# Output every command that modifies files on the build system. +#export DH_VERBOSE = 1 + +export PYBUILD_DESTDIR=debian/blag +export PYBUILD_TEST_ARGS=--no-cov +export PYBUILD_NAME=blag + +%: + dh $@ --with python3 --buildsystem=pybuild + + +# If you need to rebuild the Sphinx documentation: +# Add sphinxdoc to the dh --with line. +# +# And uncomment the following lines. +#execute_after_dh_auto_build-indep: export http_proxy=127.0.0.1:9 +#execute_after_dh_auto_build-indep: export https_proxy=127.0.0.1:9 +#execute_after_dh_auto_build-indep: +# PYTHONPATH=. python3 -m sphinx -N -bhtml \ +# docs/ build/html # HTML generator +# PYTHONPATH=. python3 -m sphinx -N -bman \ +# docs/ build/man # Manpage generator diff --git a/debian/source/format b/debian/source/format new file mode 100644 index 0000000..89ae9db --- /dev/null +++ b/debian/source/format @@ -0,0 +1 @@ +3.0 (native)