.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.47.5.
.TH DEBTAGS "1" "January 2018" "debtags 2.1" "User Commands"
.SH NAME
debtags \- Debian Package Tags support tools
.SH DESCRIPTION
usage: debtags [\-h] [\-\-version] [\-\-verbose] [\-\-debug]
.IP
{tag,cat,grep,check,diff,mkpatch,search,dumpavail,show,submit,tagcat,tagshow,tagsearch,update,vocfilter}
\&...
.PP
Command line interface to access and manipulate Debian Package Tags
.SS "optional arguments:"
.TP
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
.TP
\fB\-\-version\fR
show program's version number and exit
.TP
\fB\-\-verbose\fR, \fB\-v\fR
enable verbose output
.TP
\fB\-\-debug\fR
enable debugging output (including verbose output)
.SS "subcommands:"
.IP
valid subcommands
.TP
{tag,cat,grep,check,diff,mkpatch,search,dumpavail,show,submit,tagcat,tagshow,tagsearch,update,vocfilter}
additional help
.TP
tag
(not implemented anymore)
.TP
cat (grep)
output the lines of the full package tag database that
match the given tag expression. A tag expression
(given as a single argument) is an arbitrarily complex
binary expression of tag names. For example:
role::program && ((use::editing || use::viewing) &&
!works\-with::text)
.TP
check
Check that all the tags in the given tagged collection
are present in the tag vocabulary. Checks the main
database if no file is specified
.TP
diff (mkpatch)
Create a tag patch between the current tag database
and the tag collection [filename]. Standard input is
used if filename is not specified
.TP
search (dumpavail)
Output the packages matching the given tag expression
.TP
show
(deprecated) mostly the same as apt\-cache show
<pkgnames>
.TP
submit
(no longer supported) see
https://debtags.debian.org/api/patch for patch submit.
.TP
tagcat
Output the tag vocabulary
.TP
tagshow
Show the vocabulary information about a tag
.TP
tagsearch
Show a summary of all tags whose data contains the
given strings
.TP
update
Updates the package tag database (requires root)
Collect package tag data from apt cache, regenerate
the debtags tag database and main index. It needs to
be run as root
.TP
vocfilter
Filter out the tags that are not found in the given
vocabulary file
\fBdebtags\fP manages package tag data in a debian system and performs basic
queries on it.
.P
\fBdebtags\fP can be used to perform basic queries on the Debtags system: the
vocabulary can be queried with the \fBtagshow\fP and \fBtagsearch\fP commands;
a package tag database can be checked against the vocabulary with the
\fBcheck\fP command; the whole collection can be copied to standard output to
be processed with \fBtagcoll\fP or other tools by the \fBcat\fP command;
packages can be searched by tags using the \fBgrep\fP command. Finally, tags
can be listed with \fBtag ls\fP, edited with the \fBtag add\fP and \fBtag
rm\fP, and submitted to the Debtags database with \fBsubmit\fP.
.P
The \fBupdate\fP command can be used to download extra tags as listed in
\fI/etc/debtags/sources.list\fP: see the contents of that file for more
information.
.SH FILES
.TP
.B /var/lib/debtags/vocabulary
.br
The normative tag vocabulary
.TP
.B /var/lib/debtags/package\-tags
.br
The system package tags database, only kept as an easily parsable reference.
In the same directory there is a the binary index with the same content, used
by applications for fast access.
.TP
.B /etc/debtags/sources.list
.br
The list of sources to build the package tags database from
.SH EXAMPLES
Here are some example invocations of \fBdebtags\fP:
.P
.nf
  # Update the package tag database
  debtags update

  # Show apt-cache information about the mutt package,
  # adding tag information
  debtags show mutt

  # Search the tag vocabulary for mail-related tags
  debtags tagsearch mail

  # Output a list of all packages which can edit raster images, excluding
  # shared libraries and dummy packages
  debtags search "use::editing && works-with::image:raster && \\
                ! (role::shared-lib || role::dummy)"

  # Show all mail clients
  debtags search 'works-with::mail && network::client'

  # Output the collection of all mail clients, ready to be reprocessed via
  # tagcoll
  debtags grep 'works-with::mail && network::client'

  # Produce an easily navigable hierarchy with the collection data
  debtags cat | tagcoll hierarchy

  # Produce a local tag patch
  debtags cat > work-tags
  ...edit work-tags...
  debtags diff work-tags > my-tagpatch

  # Submit the patch
  debtags submit my-tagpatch

  # Edit the tags of a package (the patch will be stored in ~/.debtags/patch)
  # then send your changes
  debtags tag add debtags implemented-in::c++ interface::commandline
  debtags tag rm debtags devel::buildtools
  debtags submit
.fi
.SH "SEE ALSO"
.BR tagcoll (1),
.BR axi-cache (1),
.br
.BR http://wiki.debian.org/Debtags
.br
.BR http://debtags.debian.net