Skip site navigation (1)Skip section navigation (2)

FreeBSD Man Pages

Man Page or Keyword Search:
Man Architecture
Apropos Keyword Search (all sections) Output format
home | help
PKG-ANNOTATE(8)         FreeBSD System Manager's Manual        PKG-ANNOTATE(8)

NAME
     pkg annotate - add, modify or delete arbitrary annotations from packages

SYNOPSIS
     pkg annotate [-giqxy] -A|M pkg-name tag [value]
     pkg annotate [-giqxy] -D pkg-name tag
     pkg annotate [-qy] -a -A|M tag [value]
     pkg annotate [-qy] -a -D tag

DESCRIPTION
     pkg annotate is used to add, modify or delete package annotations.  These
     are freeform tag-value pairs which may contain any arbitrary text.  Tags
     must be unique per package, but there is no restriction on what text
     values may be attached to them.

     The tag is always specified on the command line, but when adding or
     modifying an annotation, the value may be supplied either on the command
     line or as a text stream on stdin.

OPTIONS
     The following options are supported by pkg annotate:

     -a  Annotate all installed packages.

     -A  The operation is to add a new annotation.  Attempting to add an
         annotation with a tag that already applies to that package is an
         error, but this will not cause pkg annotate to exit before attempting
         to apply the annotation to all remaining matched packages.

     -D  The operation is to delete an annotation.  Only the tag needs to be
         specified.  Attempting to delete an annotation which does not exist
         on a package is an error, but this will not prevent pkg annotate
         carrying on to delete the annotation from all matched packages.

     -g  Treat pkg-name as a shell glob pattern.

     -i  Make the default or the regular expression (-x) pkg-name matching
         case insensitive.

     -M  The operation is to modify a previously existing annotation.
         Functionally, this behaves similarly to -A except that it will
         succeed irrespective of whether the tag already applies to all the
         matched packages.

     -q  Operate quietly: do not output anything other than confirmatory
         questions.

     -x  Treat pkg-name as a regular expression according to the "modern" or
         "extended" syntax of re_format(7).

     -y  Assume "yes" as the answer to all questions.

ENVIRONMENT
     The following environment variables affect the execution of pkg annotate.
     See pkg.conf(5) for further description.

     PKG_DBDIR

     ASSUME_ALWAYS_YES

FILES
     See pkg.conf(5).

SEE ALSO
     pkg.conf(5), pkg(8), pkg-add(8), pkg-audit(8), pkg-autoremove(8),
     pkg-backup(8), pkg-check(8), pkg-clean(8), pkg-config(8), pkg-convert(8),
     pkg-create(8), pkg-delete(8), pkg-fetch(8), pkg-info(8), pkg-install(8),
     pkg-lock(8), pkg-query(8), pkg-register(8), pkg-repo(8), pkg-rquery(8),
     pkg-search(8), pkg-set(8), pkg-shell(8), pkg-shlib(8), pkg-stats(8),
     pkg-update(8), pkg-updating(8), pkg-upgrade(8), pkg-version(8),
     pkg-which(8)

FreeBSD 11.0-PRERELEASE          April 6, 2013         FreeBSD 11.0-PRERELEASE

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | ENVIRONMENT | FILES | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=pkg-annotate&sektion=8&manpath=FreeBSD+10.0-RELEASE>

home | help