Skip to content

Commit fe9b2e1

Browse files
nochielnochiel
committed
Add Debian metadata.
1 parent 3f12c11 commit fe9b2e1

23 files changed

+977
-0
lines changed

‎debian/README.Debian‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
sweeptool-cli for Debian
2+
-----------------------
3+
4+
<Possible notes regarding this package - if none, delete this file.>
5+
6+
-- unknown <nik@unknown> Tue, 14 Feb 2023 03:27:31 +0300

‎debian/README.source‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
sweeptool-cli for Debian
2+
-----------------------
3+
4+
<This file describes information about the source package, see Debian policy
5+
manual section 4.14. You WILL either need to modify or delete this file.>
6+
7+
8+
9+
-- unknown <nik@unknown> Tue, 14 Feb 2023 03:27:31 +0300
10+

‎debian/changelog‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
sweeptool-cli (0.1.0-1) UNRELEASED; urgency=medium
2+
3+
* Initial release. (Closes: #nnnn) <nnnn is the bug number of your ITP>
4+
5+
-- unknown <nik@unknown> Tue, 14 Feb 2023 03:27:31 +0300

‎debian/clean‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/target/

‎debian/control‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
Source: sweeptool-cli
2+
Section: unknown
3+
Priority: optional
4+
Maintainer: unknown <nik@unknown>
5+
Rules-Requires-Root: no
6+
Build-Depends:
7+
debhelper-compat (= 13),
8+
cargo
9+
Standards-Version: 4.6.1
10+
Homepage: <insert the upstream URL, if relevant>
11+
#Vcs-Browser: https://salsa.debian.org/debian/sweeptool-cli
12+
#Vcs-Git: https://salsa.debian.org/debian/sweeptool-cli.git
13+
14+
Package: sweeptool-cli
15+
Architecture: any
16+
Depends:
17+
${shlibs:Depends},
18+
${misc:Depends},
19+
Description: <insert up to 60 chars description>
20+
<Insert long description, indented with spaces.>

‎debian/copyright‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
2+
Source: <url://example.com>
3+
Upstream-Name: sweeptool-cli
4+
Upstream-Contact: <preferred name and address to reach the upstream project>
5+
6+
Files:
7+
*
8+
Copyright:
9+
<years> <put author's name and email here>
10+
<years> <likewise for another author>
11+
License: <special license>
12+
<Put the license of the package here indented by 1 space>
13+
<This follows the format of Description: lines in control file>
14+
.
15+
<Including paragraphs>
16+
17+
# If you want to use GPL v2 or later for the /debian/* files use
18+
# the following clauses, or change it to suit. Delete these two lines
19+
Files:
20+
debian/*
21+
Copyright:
22+
2023 unknown <nik@unknown>
23+
License: GPL-2+
24+
This package is free software; you can redistribute it and/or modify
25+
it under the terms of the GNU General Public License as published by
26+
the Free Software Foundation; either version 2 of the License, or
27+
(at your option) any later version.
28+
.
29+
This package is distributed in the hope that it will be useful,
30+
but WITHOUT ANY WARRANTY; without even the implied warranty of
31+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32+
GNU General Public License for more details.
33+
.
34+
You should have received a copy of the GNU General Public License
35+
along with this program. If not, see <https://www.gnu.org/licenses/>
36+
Comment:
37+
On Debian systems, the complete text of the GNU General
38+
Public License version 2 can be found in "/usr/share/common-licenses/GPL-2".
39+
40+
# Please also look if there are files or directories which have a
41+
# different copyright/license attached and list them here.
42+
# Please avoid picking licenses with terms that are more restrictive than the
43+
# packaged work, as it may make Debian's contributions unacceptable upstream.
44+
#
45+
# If you need, there are some extra license texts available in two places:
46+
# /usr/share/debhelper/dh_make/licenses/
47+
# /usr/share/common-licenses/

‎debian/manpage.1.ex‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.\" Hey, EMACS: -*- nroff -*-
2+
.\" (C) Copyright 2023 unknown <nik@unknown>,
3+
.\"
4+
.\" First parameter, NAME, should be all caps
5+
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
6+
.\" other parameters are allowed: see man(7), man(1)
7+
.TH Sweeptool-cli SECTION "February 14 2023"
8+
.\" Please adjust this date whenever revising the manpage.
9+
.\"
10+
.\" Some roff macros, for reference:
11+
.\" .nh disable hyphenation
12+
.\" .hy enable hyphenation
13+
.\" .ad l left justify
14+
.\" .ad b justify to both left and right margins
15+
.\" .nf disable filling
16+
.\" .fi enable filling
17+
.\" .br insert line break
18+
.\" .sp <n> insert n+1 empty lines
19+
.\" for manpage-specific macros, see man(7)
20+
.SH NAME
21+
sweeptool-cli \- program to do something
22+
.SH SYNOPSIS
23+
.B sweeptool-cli
24+
.RI [ options ] " files" ...
25+
.br
26+
.B bar
27+
.RI [ options ] " files" ...
28+
.SH DESCRIPTION
29+
This manual page documents briefly the
30+
.B sweeptool-cli
31+
and
32+
.B bar
33+
commands.
34+
.PP
35+
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
36+
.\" \fI<whatever>\fP escape sequences to invode bold face and italics,
37+
.\" respectively.
38+
\fBsweeptool-cli\fP is a program that...
39+
.SH OPTIONS
40+
These programs follow the usual GNU command line syntax, with long
41+
options starting with two dashes ('\-').
42+
A summary of options is included below.
43+
For a complete description, see the Info files.
44+
.TP
45+
.B \-h, \-\-help
46+
Show summary of options.
47+
.TP
48+
.B \-v, \-\-version
49+
Show version of program.
50+
.SH SEE ALSO
51+
.BR bar (1),
52+
.BR baz (1).
53+
.br
54+
The programs are documented fully by
55+
.IR "The Rise and Fall of a Fooish Bar" ,
56+
available via the Info system.

‎debian/manpage.md.ex‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
% sweeptool-cli(SECTION) | User Commands
2+
%
3+
% "February 14 2023"
4+
5+
[comment]: # The lines above form a Pandoc metadata block. They must be
6+
[comment]: # the first ones in the file.
7+
[comment]: # See https://pandoc.org/MANUAL.html#metadata-blocks for details.
8+
9+
[comment]: # pandoc -s -f markdown -t man package.md -o package.1
10+
[comment]: #
11+
[comment]: # A manual page package.1 will be generated. You may view the
12+
[comment]: # manual page with: nroff -man package.1 | less. A typical entry
13+
[comment]: # in a Makefile or Makefile.am is:
14+
[comment]: #
15+
[comment]: # package.1: package.md
16+
[comment]: # pandoc --standalone --from=markdown --to=man $< --output=$@
17+
[comment]: #
18+
[comment]: # The pandoc binary is found in the pandoc package. Please remember
19+
[comment]: # that if you create the nroff version in one of the debian/rules
20+
[comment]: # file targets, such as build, you will need to include pandoc in
21+
[comment]: # your Build-Depends control field.
22+
23+
[comment]: # Remove the lines starting with '[comment]:' in this file in order
24+
[comment]: # to avoid warning messages from pandoc.
25+
26+
# NAME
27+
28+
sweeptool-cli - program to do something
29+
30+
# SYNOPSIS
31+
32+
**sweeptool-cli** **-e** _this_ [**\-\-example=that**] [{**-e** | **\-\-example**} _this_]
33+
[{**-e** | **\-\-example**} {_this_ | _that_}]
34+
35+
**sweeptool-cli** [{**-h** | *\-\-help**} | {**-v** | **\-\-version**}]
36+
37+
# DESCRIPTION
38+
39+
This manual page documents briefly the **sweeptool-cli** and **bar** commands.
40+
41+
This manual page was written for the Debian distribution because the
42+
original program does not have a manual page. Instead, it has documentation
43+
in the GNU info(1) format; see below.
44+
45+
**sweeptool-cli** is a program that...
46+
47+
# OPTIONS
48+
49+
The program follows the usual GNU command line syntax, with long options
50+
starting with two dashes ('-'). A summary of options is included below. For
51+
a complete description, see the **info**(1) files.
52+
53+
**-e** _this_, **\-\-example=**_that_
54+
: Does this and that.
55+
56+
**-h**, **\-\-help**
57+
: Show summary of options.
58+
59+
**-v**, **\-\-version**
60+
: Show version of program.
61+
62+
# FILES
63+
64+
/etc/foo.conf
65+
: The system-wide configuration file to control the behaviour of
66+
sweeptool-cli. See **foo.conf**(5) for further details.
67+
68+
${HOME}/.foo.conf
69+
: The per-user configuration file to control the behaviour of
70+
sweeptool-cli. See **foo.conf**(5) for further details.
71+
72+
# ENVIRONMENT
73+
74+
**FOO_CONF**
75+
: If used, the defined file is used as configuration file (see also
76+
the section called “FILES”).
77+
78+
# DIAGNOSTICS
79+
80+
The following diagnostics may be issued on stderr:
81+
82+
Bad configuration file. Exiting.
83+
: The configuration file seems to contain a broken configuration
84+
line. Use the **\-\-verbose** option, to get more info.
85+
86+
**sweeptool-cli** provides some return codes, that can be used in scripts:
87+
88+
Code Diagnostic
89+
0 Program exited successfully.
90+
1 The configuration file seems to be broken.
91+
92+
# BUGS
93+
94+
The program is currently limited to only work with the foobar library.
95+
96+
The upstream BTS can be found at http://bugzilla.foo.tld.
97+
98+
# SEE ALSO
99+
100+
**bar**(1), **baz**(1), **foo.conf**(5)
101+
102+
The programs are documented fully by The Rise and Fall of a Fooish Bar
103+
available via the **info**(1) system.
104+
105+
# AUTHOR
106+
107+
unknown <nik@unknown>
108+
: Wrote this manpage for the Debian system.
109+
110+
# COPYRIGHT
111+
112+
Copyright © 2007 unknown
113+
114+
This manual page was written for the Debian system (and may be used by
115+
others).
116+
117+
Permission is granted to copy, distribute and/or modify this document under
118+
the terms of the GNU General Public License, Version 2 or (at your option)
119+
any later version published by the Free Software Foundation.
120+
121+
On Debian systems, the complete text of the GNU General Public License
122+
can be found in /usr/share/common-licenses/GPL.
123+
124+
[comment]: # Local Variables:
125+
[comment]: # mode: markdown
126+
[comment]: # End:

0 commit comments

Comments
 (0)