pkg-info.8
1 .\" 2 .\" FreeBSD pkg - a next generation package for the installation and maintenance 3 .\" of non-core utilities. 4 .\" 5 .\" Redistribution and use in source and binary forms, with or without 6 .\" modification, are permitted provided that the following conditions 7 .\" are met: 8 .\" 1. Redistributions of source code must retain the above copyright 9 .\" notice, this list of conditions and the following disclaimer. 10 .\" 2. Redistributions in binary form must reproduce the above copyright 11 .\" notice, this list of conditions and the following disclaimer in the 12 .\" documentation and/or other materials provided with the distribution. 13 .\" 14 .\" 15 .\" @(#)pkg.8 16 .\" 17 .Dd December 1, 2014 18 .Dt PKG-INFO 8 19 .Os 20 .Sh NAME 21 .Nm "pkg info" 22 .Nd display information for packages 23 .Sh SYNOPSIS 24 .Nm 25 .Ar pkg-name 26 .Nm 27 .Fl a 28 .Nm 29 .Op Fl ABbDdefIklOpqRrs 30 .Op Fl Cgix 31 .Ar pkg-name 32 .Nm 33 .Op Fl ABbDdfIlpqRrs 34 .Fl F Ar pkg-file 35 .Pp 36 .Nm 37 .Ar pkg-name 38 .Nm 39 .Cm --all 40 .Nm 41 .Op Cm --{annotations,provided-shlibs,required-shlibs} 42 .Op Cm --{pkg-message,dependencies,exists,full,comment,locked} 43 .Op Cm --{list-files,by-origin,quiet,prefix,raw,required-by,size} 44 .Op Cm --{case-sensitive,glob,case-insensitive,regex} 45 .Ar pkg-name 46 .Nm 47 .Op Cm --{annotations,provided-shlibs,required-shlibs} 48 .Op Cm --{pkg-message,dependencies,full,comment,list-files} 49 .Op Cm --{quiet,prefix,raw,required-by,size} 50 .Cm --file Ar pkg-file 51 .Op Fl -raw-format Ar format 52 .Sh DESCRIPTION 53 .Nm 54 is used for displaying information for packages. 55 .Sh OPTIONS 56 The following options are supported by 57 .Nm : 58 .Bl -tag -width origin 59 .It Fl A , Cm --annotations 60 Display any annotations added to the package. 61 .It Fl a , Cm --all 62 Display all installed packages. 63 .It Fl B , Cm --required-shlibs 64 Display all shared libraries used by 65 .Ar pkg-name . 66 .It Fl b , Cm --provided-shlibs 67 Display all shared libraries provided by 68 .Ar pkg-name . 69 .It Fl C , Cm --case-sensitive 70 Make the standard or the regular expression 71 .Fl ( x ) 72 matching against 73 .Ar pkg-name 74 case sensitive. 75 .It Fl D , Cm --pkg-message 76 Show the pkg-message for matching packages. 77 .It Fl d , Cm --dependencies 78 Display the list of packages on which 79 .Ar pkg-name 80 depends. 81 .It Fl E , Cm --show-name-only 82 Hides the full package output and only shows the package name. 83 This option is deprecated and exists only for Ports compatibility. 84 .It Fl e , Cm --exists 85 If 86 .Ar pkg-name 87 is installed and registered in the database, return 0, otherwise return 1. 88 Useful for checking whether the package is installed. 89 .It Fl F Ar pkg-file , Cm --file Ar pkg-file 90 Displays information from the package archive 91 .Ar pkg-file . 92 .It Fl f , Cm --full 93 Display full information about the packages matching 94 .Ar pkg-name . 95 This is the default. 96 .It Fl g , Cm --glob 97 Treat 98 .Ar pkg-name 99 as a shell glob pattern. 100 .It Fl I , Cm --comment 101 Display the specified packages and their comments. 102 .It Fl i , Cm --case-insensitive 103 Make the standard or the regular expression 104 .Fl ( x ) 105 matching against 106 .Ar pkg-name 107 case insensitive. 108 This is the default, unless modified by setting 109 .Ev CASE_SENSITIVE_MATCH 110 to true in 111 .Pa pkg.conf . 112 .It Fl k , Cm --locked 113 Show the locking status for 114 .Ar pkg-name . 115 When used in combination with 116 .Fl d 117 or 118 .Fl r , 119 indicate which packages, dependencies or requirements are locked 120 by '(*)'. 121 Locking status is only meaningful for installed packages; all locking 122 statuses will show as unlocked when information about a 123 .Ar pkg-file 124 is queried. 125 .It Fl l , Cm --list-files 126 Display all files installed by 127 .Ar pkg-name . 128 .It Fl O , Cm --by-origin 129 Search is done by the 130 .Ar pkg-name 131 origin. 132 Added only for Ports compatibility. 133 .Pp 134 .It Fl o , Cm --origin 135 Display 136 .Ar pkg-name 137 origin. 138 .It Fl p , Cm --prefix 139 Display the installation prefix for each package matching 140 .Ar pkg-name . 141 .It Fl q , Cm --quiet 142 Be 143 .Dq quiet . 144 Prints only the requested information without displaying many hints. 145 .It Fl R , Cm --raw 146 Display the full manifest (raw) for the packages matching 147 .Ar pkg-name . 148 .It Fl r , Cm --required-by 149 Display the list of packages which require 150 .Ar pkg-name . 151 .It Fl -raw-format Ar format 152 Choose the format of the raw output. 153 The format can be: ucl (default), 154 json, json-compact, yaml. 155 .It Fl s , Cm --size 156 Display the total size of files installed by 157 .Ar pkg-name . 158 .It Fl x , Cm --regex 159 Treat 160 .Ar pkg-name 161 as a regular expression according to the "modern" or "extended" syntax 162 of 163 .Xr re_format 7 . 164 .El 165 .Sh ENVIRONMENT 166 The following environment variables affect the execution of 167 .Nm . 168 See 169 .Xr pkg.conf 5 170 for further description. 171 .Bl -tag -width ".Ev NO_DESCRIPTIONS" 172 .It Ev PKG_DBDIR 173 .It Ev CASE_SENSITIVE_MATCH 174 .El 175 .Sh FILES 176 See 177 .Xr pkg.conf 5 . 178 .Sh SEE ALSO 179 .Xr pkg_create 3 , 180 .Xr pkg_printf 3 , 181 .Xr pkg_repo_create 3 , 182 .Xr pkg_repos 3 , 183 .Xr pkg-keywords 5 , 184 .Xr pkg-lua-script 5 , 185 .Xr pkg-repository 5 , 186 .Xr pkg-script 5 , 187 .Xr pkg-triggers 5 , 188 .Xr pkg.conf 5 , 189 .Xr pkg 8 , 190 .Xr pkg-add 8 , 191 .Xr pkg-alias 8 , 192 .Xr pkg-annotate 8 , 193 .Xr pkg-audit 8 , 194 .Xr pkg-autoremove 8 , 195 .Xr pkg-check 8 , 196 .Xr pkg-clean 8 , 197 .Xr pkg-config 8 , 198 .Xr pkg-create 8 , 199 .Xr pkg-delete 8 , 200 .Xr pkg-fetch 8 , 201 .Xr pkg-help 8 , 202 .Xr pkg-install 8 , 203 .Xr pkg-key 8 , 204 .Xr pkg-lock 8 , 205 .Xr pkg-plugins 8 , 206 .Xr pkg-query 8 , 207 .Xr pkg-register 8 , 208 .Xr pkg-repo 8 , 209 .Xr pkg-repositories 8 , 210 .Xr pkg-rquery 8 , 211 .Xr pkg-search 8 , 212 .Xr pkg-set 8 , 213 .Xr pkg-shell 8 , 214 .Xr pkg-shlib 8 , 215 .Xr pkg-ssh 8 , 216 .Xr pkg-stats 8 , 217 .Xr pkg-triggers 8 , 218 .Xr pkg-unregister 8 , 219 .Xr pkg-update 8 , 220 .Xr pkg-updating 8 , 221 .Xr pkg-upgrade 8 , 222 .Xr pkg-version 8 , 223 .Xr pkg-which 8