summaryrefslogtreecommitdiff
path: root/sort-dctrl.1.cp
blob: 225cbd356b90f330f1e494094480b5b044199c81 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
.TH SORT-DCTRL 1 2005-06-08 "Debian Project" "Debian user's manual"
\" Copyright (C) 2005 Antti-Juhani Kaijanaho <gaia@iki.fi>
\"      This program is free software; you can redistribute it and/or modify
\"      it under the terms of the GNU General Public License as published by
\"      the Free Software Foundation; either version 2 of the License, or
\"      (at your option) any later version.
\" 
\"      This program is distributed in the hope that it will be useful,
\"      but WITHOUT ANY WARRANTY; without even the implied warranty of
\"      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
\"      GNU General Public License for more details. 
\"  
\"      You should have received a copy of the GNU General Public License
\"      along with this program; see the file COPYING.  If not, write to
\"      the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
\"      Boston, MA 02111-1307, USA.
.SH NAME
sort\-dctrl \- sort Debian control files
.SH SYNOPSIS
.B sort\-dctrl
[options]
[
.IR file " ..."
]
.sp
.B sort\-dctrl
\-\-copying | \-\-help | \-\-version | \-ChV
.SH DESCRIPTION
The
.B sort\-dctrl
program sorts Debian control files according to specified criteria.
.PP
A Debian control (dctrl) file is a semistructured single-table
database stored in a machine-parseable text file.  Such a database
consists of a set of records; each record is a mapping from field
names to field content.  Textually, records are separated by empty
lines, while each field is encoded as one or more nonempty lines
inside a record.  A field starts with its name, followed by a colon,
followed by the field content.  The colon must reside on the first
line of the field, and the first line must start with no whitespace.
Subsequent lines, in contrast, always start with linear whitespace
(one or more space or tab characters).
.PP
The
.B sort\-dctrl
program recognizes two field types: string fields and version fields.
Version fields act also as numeric fields.  String fields are compared
according to strict lexicographical octet-by-octet comparison, after
ignoring any initial whitespace after the colon.  Version fields are
parsed and compared as Debian version numbers.  When comparing version
numbers, if a field content does not in fact conform to the version
number syntax, it compares less than any field content that does
conform, and equal to any other nonconforming field content.  The
.B sort\-dctrl
program assumes all fields are string fields unless told otherwise.
.PP
You can specify arbitrary number of keys for sorting, using the \-k
option.  The keys are interpreted in a descending order of priority:
the first key specified is primary, the second key specified is
secondary, and so on.  If two records compare equal under the primary
key, then they are compared under the secondary key, and so on.  If no
keys are specified, a default key is assumed (the "Package" field with
no modifiers).
.SH OPTIONS
.IP "-k KEYSPEC, --key-spec=KEYSPEC"
Specify one or more keys for sorting.  You may specify this option any
number of times.  The KEYSPEC argument consists of a comma-separated
list of key specifications.  Each key specification consists of the
name of the field that serves as the key, optionally followed by a
colon and key modifiers.  The following key modifiers are supported:
.RS
.TP
.B r
Invert the comparison for this key, reversing the sorting order.
.TP
.B v
Treat this field as a version number field.
.TP
.B n
Treat this field as numeric, which currently is synonymous with 
.BR v .
.RE
.IP "\-q, \-\-quiet, \-\-silent"
Output nothing to the standard output stream.  Instead, exit
immediately after finding the first match.
.IP "\-l LEVEL, \-\-errorlevel=LEVEL"
Set debugging level to LEVEL.  LEVEL is one of "fatal", "important",
"informational" and "debug", but the last may not be available,
depending on the compile-time options.  These categories are given
here in order; every message that is emitted when "fatal" is in
effect, will be emitted in the "important" error level, and so on.
The default is "important".
.IP "\-V, \-\-version"
Print out version information.
.IP "\-C, \-\-copying"
Print out the copyright license.  This produces much output; be sure
to redirect or pipe it somewhere (such as your favourite pager).
.IP "\-h, \-\-help"
Print out a help summary.
.SH EXAMPLES
Here are some sample invocations of the program:
.IP "sort\-dctrl /var/lib/dpkg/available"
Output the dpkg available file sorted by the package name.
.IP "sort\-dctrl -k Version:v /var/lib/dpkg/available"
Output the dpkg available file sorted in ascending order of
version numbers.
.IP "sort\-dctrl -k Version:vr /var/lib/dpkg/available"
Output the dpkg available file sorted in descending order of
version numbers.
.IP "sort\-dctrl -k Package,Version:v /var/lib/dpkg/available"
Output the dpkg available file sorted primarily in ascending order of
package names and secondarily in descending order of version numbers.
.IP "sort\-dctrl -k Installed-Size:n,Size:nr /var/lib/dpkg/available"
Output the dpkg available file sorted primarily in ascending order of
installation sizes and secondarily in descending order of package
sizes.
.SH AUTHOR
The program and this manual page were written by Antti-Juhani
Kaijanaho <ajk@debian.org>.
.SH "SEE ALSO"
Ian Jackson et al.: Debian Policy Manual.  Published as the Debian
package debian\-policy.  Also available in the Debian website.  The
Debian project, 2004.
.PP
.BR grep-dctrl (1)
\" Local variables:
\" mode: nroff
\" End: