JavaScript is required to for searching.
Skip Navigation Links
Exit Print View
man pages section 1: User Commands     Oracle Solaris 11.1 Information Library
search filter icon
search icon

Document Information

Preface

Introduction

User Commands

acctcom(1)

adb(1)

addbib(1)

admin(1)

alias(1)

allocate(1)

amt(1)

appcert(1)

apptrace(1)

apropos(1)

ar(1)

arch(1)

as(1)

asa(1)

at(1)

atq(1)

atrm(1)

audioconvert(1)

audioctl(1)

audioplay(1)

audiorecord(1)

audiotest(1)

auths(1)

auto_ef(1)

awk(1)

banner(1)

basename(1)

basename(1B)

batch(1)

bc(1)

bdiff(1)

bfs(1)

bg(1)

biff(1B)

break(1)

builtin(1)

cal(1)

calendar(1)

case(1)

cat(1)

cd(1)

cdc(1)

cdrw(1)

chdir(1)

checkeq(1)

checknr(1)

chgrp(1)

chkey(1)

chmod(1)

chown(1)

chown(1B)

ckdate(1)

ckgid(1)

ckint(1)

ckitem(1)

ckkeywd(1)

ckpath(1)

ckrange(1)

ckstr(1)

cksum(1)

cktime(1)

ckuid(1)

ckyorn(1)

clear(1)

cmp(1)

col(1)

comb(1)

comm(1)

command(1)

compress(1)

continue(1)

cp(1)

cpio(1)

cpp(1)

cputrack(1)

crle(1)

crontab(1)

csh(1)

csplit(1)

ct(1C)

ctags(1)

ctrun(1)

ctstat(1)

ctwatch(1)

cu(1C)

cut(1)

date(1)

dc(1)

deallocate(1)

decrypt(1)

delta(1)

deroff(1)

df(1B)

dhcpinfo(1)

diff(1)

diff3(1)

diffmk(1)

digest(1)

digestp(1)

dircmp(1)

dirname(1)

dirs(1)

dis(1)

disown(1)

dispgid(1)

dispuid(1)

dos2unix(1)

dpost(1)

du(1)

du(1B)

dump(1)

dumpcs(1)

dumpkeys(1)

echo(1)

echo(1B)

ed(1)

edit(1)

egrep(1)

eject(1)

elfdump(1)

elfedit(1)

elffile(1)

elfsign(1)

elfwrap(1)

encrypt(1)

enhance(1)

env(1)

eqn(1)

errange(1)

errdate(1)

errgid(1)

errint(1)

erritem(1)

error(1)

errpath(1)

errstr(1)

errtime(1)

erruid(1)

erryorn(1)

eval(1)

ex(1)

exec(1)

exit(1)

expand(1)

export(1)

exportfs(1B)

expr(1)

expr(1B)

exstr(1)

factor(1)

false(1)

fastboot(1B)

fasthalt(1B)

fc(1)

fg(1)

fgrep(1)

file(1)

file(1B)

filebench(1)

filep(1)

filesync(1)

filofaxp(1)

find(1)

finger(1)

fmt(1)

fmtmsg(1)

fold(1)

for(1)

foreach(1)

franklinp(1)

from(1B)

ftp(1)

function(1)

gcore(1)

gencat(1)

geniconvtbl(1)

genmsg(1)

get(1)

getconf(1)

getfacl(1)

getlabel(1)

getopt(1)

getoptcvt(1)

getopts(1)

gettext(1)

gettxt(1)

getzonepath(1)

glob(1)

goto(1)

gprof(1)

grep(1)

groups(1)

groups(1B)

grpck(1B)

hash(1)

hashcheck(1)

hashmake(1)

hashstat(1)

head(1)

helpdate(1)

helpgid(1)

helpint(1)

helpitem(1)

helppath(1)

helprange(1)

helpstr(1)

helptime(1)

helpuid(1)

helpyorn(1)

hist(1)

history(1)

hostid(1)

hostname(1)

i386(1)

i486(1)

iconv(1)

if(1)

indxbib(1)

install(1B)

ipcrm(1)

ipcs(1)

isainfo(1)

isalist(1)

jobs(1)

join(1)

jsh(1)

kbd(1)

kdestroy(1)

keylogin(1)

keylogout(1)

kill(1)

kinit(1)

klist(1)

kmdb(1)

kmfcfg(1)

kpasswd(1)

krb5-config(1)

ksh(1)

ksh88(1)

ksh93(1)

ktutil(1)

kvno(1)

lari(1)

last(1)

lastcomm(1)

ld(1)

ldapadd(1)

ldapdelete(1)

ldaplist(1)

ldapmodify(1)

ldapmodrdn(1)

ldapsearch(1)

ldd(1)

ld.so.1(1)

let(1)

lex(1)

lgrpinfo(1)

limit(1)

line(1)

list_devices(1)

listusers(1)

llc2_autoconfig(1)

llc2_config(1)

llc2_stats(1)

ln(1)

ln(1B)

loadkeys(1)

locale(1)

localedef(1)

logger(1)

logger(1B)

login(1)

logname(1)

logout(1)

look(1)

lookbib(1)

lorder(1)

ls(1)

ls(1B)

m4(1)

mac(1)

mach(1)

machid(1)

madv.so.1(1)

mail(1)

Mail(1B)

mail(1B)

mailcompat(1)

mailp(1)

mailq(1)

mailstats(1)

mailx(1)

make(1S)

makekey(1)

man(1)

mconnect(1)

mcs(1)

mdb(1)

mesg(1)

mkdir(1)

mkmsgs(1)

mkstr(1B)

mktemp(1)

moe(1)

more(1)

mp(1)

mpss.so.1(1)

msgcc(1)

msgcpp(1)

msgcvt(1)

msgfmt(1)

msggen(1)

msgget(1)

mt(1)

mv(1)

nawk(1)

nc(1)

ncab2clf(1)

ncakmod(1)

neqn(1)

netcat(1)

newform(1)

newgrp(1)

newsp(1)

newtask(1)

nice(1)

nl(1)

nm(1)

nohup(1)

notify(1)

nroff(1)

od(1)

on(1)

onintr(1)

optisa(1)

pack(1)

packagemanager(1)

page(1)

pagesize(1)

pargs(1)

passwd(1)

paste(1)

patch(1)

pathchk(1)

pax(1)

pcat(1)

pcred(1)

perl(1)

pfbash(1)

pfcsh(1)

pfexec(1)

pfiles(1)

pfksh(1)

pflags(1)

pfsh(1)

pftcsh(1)

pfzsh(1)

pg(1)

pgrep(1)

pkcs11_inspect(1)

pkg(1)

pkgdepend(1)

pkgdiff(1)

pkgfmt(1)

pkginfo(1)

pkglint(1)

pkgmerge(1)

pkgmk(1)

pkgmogrify(1)

pkgparam(1)

pkgproto(1)

pkgrecv(1)

pkgrepo(1)

pkgsend(1)

pkgsign(1)

pkgtrans(1)

pkill(1)

pklogin_finder(1)

pktool(1)

plabel(1)

pldd(1)

plgrp(1)

plimit(1)

pmadvise(1)

pmap(1)

pm-updatemanager(1)

popd(1)

ppgsz(1)

ppriv(1)

pr(1)

praliases(1)

prctl(1)

preap(1)

print(1)

printenv(1B)

printf(1)

priocntl(1)

proc(1)

prof(1)

profiles(1)

projects(1)

prs(1)

prt(1)

prun(1)

ps(1)

ps(1B)

psig(1)

pstack(1)

pstop(1)

ptime(1)

ptree(1)

pushd(1)

pvs(1)

pwait(1)

pwd(1)

pwdx(1)

radadrgen(1)

ranlib(1)

rcapstat(1)

rcp(1)

read(1)

readonly(1)

red(1)

refer(1)

regcmp(1)

rehash(1)

remote_shell(1)

remsh(1)

renice(1)

repeat(1)

reset(1B)

return(1)

rksh(1)

rksh88(1)

rlogin(1)

rm(1)

rmail(1)

rmdel(1)

rmdir(1)

rmformat(1)

rmmount(1)

rmumount(1)

roffbib(1)

roles(1)

rpcgen(1)

rpm2cpio(1)

rsh(1)

runat(1)

rup(1)

rup(1C)

ruptime(1)

rusage(1B)

rusers(1)

rwho(1)

sact(1)

sar(1)

sccs(1)

sccs-admin(1)

sccs-cdc(1)

sccs-comb(1)

sccs-delta(1)

sccsdiff(1)

sccs-get(1)

sccs-help(1)

sccshelp(1)

sccs-prs(1)

sccs-prt(1)

sccs-rmdel(1)

sccs-sact(1)

sccs-sccsdiff(1)

sccs-unget(1)

sccs-val(1)

scp(1)

script(1)

sdiff(1)

sed(1)

sed(1B)

select(1)

set(1)

setenv(1)

setfacl(1)

setlabel(1)

setpgrp(1)

settime(1)

sftp(1)

sh(1)

shcomp(1)

shell_builtins(1)

shift(1)

shutdown(1B)

size(1)

sleep(1)

soelim(1)

sort(1)

sortbib(1)

sotruss(1)

source(1)

sparc(1)

spell(1)

spellin(1)

split(1)

srchtxt(1)

ssh(1)

ssh-add(1)

ssh-agent(1)

ssh-http-proxy-connect(1)

ssh-keygen(1)

ssh-keyscan(1)

ssh-socks5-proxy-connect(1)

stop(1)

strchg(1)

strconf(1)

strings(1)

strip(1)

stty(1)

stty(1B)

sum(1)

sum(1B)

sun(1)

suspend(1)

svcprop(1)

svcs(1)

switch(1)

symorder(1)

sys-suspend(1)

sysV-make(1)

t300(1)

t300s(1)

t4014(1)

t450(1)

tabs(1)

tail(1)

talk(1)

tar(1)

tbl(1)

tcopy(1)

tee(1)

tek(1)

telnet(1)

test(1)

test(1B)

tftp(1)

time(1)

timemanp(1)

times(1)

timesysp(1)

timex(1)

tip(1)

touch(1)

touch(1B)

tplot(1)

tput(1)

tr(1)

tr(1B)

trap(1)

troff(1)

true(1)

truss(1)

tset(1B)

tsort(1)

tty(1)

type(1)

typeset(1)

ul(1)

ulimit(1)

umask(1)

unalias(1)

uname(1)

uncompress(1)

unexpand(1)

unget(1)

unhash(1)

unifdef(1)

uniq(1)

units(1)

unix2dos(1)

unlimit(1)

unpack(1)

unset(1)

unsetenv(1)

until(1)

updatehome(1)

uptime(1)

userattr(1)

users(1B)

uucp(1C)

uudecode(1C)

uuencode(1C)

uuglist(1C)

uulog(1C)

uuname(1C)

uupick(1C)

uustat(1C)

uuto(1C)

uux(1C)

vacation(1)

val(1)

valdate(1)

valgid(1)

valint(1)

valpath(1)

valrange(1)

valstr(1)

valtime(1)

valuid(1)

valyorn(1)

vc(1)

vedit(1)

ver(1)

vgrind(1)

vi(1)

view(1)

vipw(1B)

volcheck(1)

volrmmount(1)

w(1)

wait(1)

wc(1)

what(1)

whatis(1)

whence(1)

whereis(1B)

which(1)

while(1)

who(1)

whoami(1B)

whocalls(1)

whois(1)

write(1)

xargs(1)

xgettext(1)

xstr(1)

yacc(1)

yes(1)

ypcat(1)

ypmatch(1)

yppasswd(1)

ypwhich(1)

zcat(1)

zlogin(1)

zonename(1)

zonestat(1)

pkgrepo

- Image Packaging System repository management utility

Synopsis

/usr/bin/pkgrepo create [--version ver] uri_or_path
/usr/bin/pkgrepo add-publisher -s repo_uri_or_path publisher ...
/usr/bin/pkgrepo get [-F format] [-H] [-p publisher ...]
    -s repo_uri_or_path [section/property ...]
/usr/bin/pkgrepo info [-F format] [-H] [-p publisher ...]
    -s repo_uri_or_path
/usr/bin/pkgrepo list [-F format] [-H] [-p publisher ...]
    -s repo_uri_or_path [pkg_fmri_pattern ...]
/usr/bin/pkgrepo rebuild [-p publisher ...]
    -s repo_uri_or_path [--no-catalog] [--no-index]
/usr/bin/pkgrepo refresh [-p publisher ...]
    -s repo_uri_or_path [--no-catalog] [--no-index]
/usr/bin/pkgrepo remove [-n] [-p publisher ...]
    -s repo_uri_or_path pkg_fmri_pattern ...
/usr/bin/pkgrepo set [-p publisher] -s repo_uri_or_path
    section/property=[value]
/usr/bin/pkgrepo set [-p publisher] -s repo_uri_or_path
    section/property=([value]) ...
/usr/bin/pkgrepo help
/usr/bin/pkgrepo version

Description

pkgrepo provides the ability to create and manage pkg(5) package repositories. Package repositories are a predefined set of directories and files that permit the storage and retrieval of package data by pkg and publication clients such as pkgsend or pkgrecv. In addition, when network-based access to a package repository is needed, pkg.depotd can provide clients access to the repository to store and/or retrieve package data.

Options

The following options are supported:

-?
--help

Display a usage message.

Sub-commands

The following subcommands are supported:

pkgrepo create [--version ver] uri_or_path

Create a pkg(5) repository at the specified location.

This subcommand can be used only with file system based repositories.

--version

Create a repository in a format compatible with the specified version. By default, version 4 repositories are created. Supported versions are:

3

Supports storage of packages for a single publisher, catalog version 1, and search version 1.

4

Supports storage of packages for multiple publishers, catalog version 1, and search version 1.

pkgrepo add-publisher -s repo_uri_or_path publisher ...

Add the specified publishers to the repository. The new publishers have no packages or content.

This subcommand can be used only with version 4 file system based repositories.

pkgrepo get [-F format] [-H] [-p publisher ...] -s repo_uri_or_path [section/property ...]

Display the property information for the repository or its publishers.

By default, each property and its value are printed on separate lines. Empty ASCII string values are represented by a pair of double quotation marks (""). The following Bourne shell metacharacters, and newline, space, and tab, in ASCII string values must be escaped by backslash characters (\):

; & ( ) | ^ < > \ " ' `

See the “Examples” section for examples displaying publisher and repository properties.

For a list of properties and the purpose and value of each property, see the set subcommand below.

-F format

Specify an alternative output format. The value of format can be tsv (Tab Separated Values), json (JavaScript Object Notation as a single line), or json-formatted (JavaScript Object Notation, formatted for readability).

-H

Omit the headers from the listing.

-p publisher

Display the property information for the given publisher. The special value all displays the properties for all publishers. This option can be specified multiple times.

-s repo_uri_or_path

Operate on the repository located at the given URI or file system path.

section/property

Display values for only the specified properties, such as publisher/prefix or repository/version. See the set subcommand for a complete list of properties.

pkgrepo info [-F format] [-H] [-p publisher ...] -s repo_uri_or_path

Display a listing of the package publishers known by the repository. The listing includes the number of packages for each publisher, when the publisher's package data was last updated, and the status of the publisher's package data (such as whether it is currently being processed).

-F format

Specify an alternative output format. The value of format can be tsv (Tab Separated Values), json (JavaScript Object Notation as a single line), or json-formatted (JavaScript Object Notation, formatted for readability).

-H

Omit the headers from the listing.

-p publisher

Only display the data for the given publisher. If not provided, the data for all publishers is displayed. This option can be specified multiple times.

-s repo_uri_or_path

Operate on the repository located at the given URI or file system path.

pkgrepo list [-F format] [-H] [-p publisher ...] -s repo_uri_or_path [pkg_fmri_pattern ...]

List the packages in the repo_uri_or_path repository that match the specified pkg_fmri_pattern patterns. If no patterns are specified, all packages in the repository are listed.

In the default output, the first column contains the name of the publisher of the package. The second column contains the name of the package. The third column is a flag that shows the status of the package. A value of o in the status column indicates the package is obsolete. A value of r in the status column indicates the package has been renamed, which is a form of obsoletion. The fourth column contains the release and branch versions of the package. See pkg(5) for information about release and branch versions.

-F format

Specify an alternative output format. The value of format can be tsv (Tab Separated Values), json (JavaScript Object Notation as a single line), or json-formatted (JavaScript Object Notation, formatted for readability).

-H

Omit the headers from the listing.

-p publisher

Only display the packages for the given publisher. If not provided, the packages for all publishers are displayed. This option can be specified multiple times.

-s repo_uri_or_path

Operate on the repository located at the given URI or file system path.

pkgrepo rebuild [-p publisher ...] -s repo_uri_or_path [--no-catalog] [--no-index]

Discard all catalog, search, and other cached information found in the repository, and then recreates it based on the current contents of the repository.

-p publisher

Perform the operation only for the given publisher. If not provided, or if the special value all is specified, the operation is performed for all publishers. This option can be specified multiple times.

-s repo_uri_or_path

Operate on the repository located at the given URI or file system path.

--no-catalog

Do not rebuild package data.

--no-index

Do not rebuild search indexes.

pkgrepo refresh [-p publisher ...] -s repo_uri_or_path [--no-catalog] [--no-index]

Catalog any new packages found in the repository and updates all search indexes. This is intended for use with deferred publication (--no-catalog or --no-index options of pkgsend).

-p publisher

Perform the operation only for the given publisher. If not provided, or if the special value all is specified, the operation is performed for all publishers. This option can be specified multiple times.

-s repo_uri_or_path

Operate on the repository located at the given URI or file system path.

--no-catalog

Do not add any new packages.

--no-index

Do not update search indexes.

pkgrepo remove [-n] [-p publisher ...] -s repo_uri_or_path pkg_fmri_pattern ...

Remove the packages matching the specified patterns from the repository, including any files they reference that are not in use by any other package.


Note - All search index data for related publishers is removed.


This subcommand can be used only with file system based repositories.


Caution

Caution - This operation is not reversible and should not be used while other clients are accessing the repository since it might cause them to fail during retrieval operations.


-n

Perform a trial run of the operation with no package changes made. A list of the packages to be removed is displayed before exiting.

-p publisher

Only remove matching packages for the given publisher. If not provided, any matching packages are removed for all publishers. This option can be specified multiple times.

-s repo_uri_or_path

Operate on the repository located at the given URI or file system path.

pkgrepo set [-p publisher] -s repo_uri_or_path section/property=[value] ...
set [-p publisher] -s repo_uri_or_path section/property=([value]) ...

Set the value of the specified properties for the repository or publisher.

This subcommand can be used only with file system based repositories.

-p publisher

Only set property data for the given publisher. If the publisher does not already exist, it is added. The special value all can be used to set the property for all publishers.

-s repo_uri_or_path

Operate on the repository located at the given URI or file system path.

Properties and values can be specified using one of the following forms:

section/property=

Clear the property value.

section/property=value

Replace the property value with the given value.

section/property=(value1 value2 valueN)

Replace the property value with the list of values.

For repository versions 3 and 4, the following properties can be set for the repository:

publisher/prefix

A string that represents the name of the default publisher. The first character must be a-z, A-Z, or 0-9. The remainder of the string can only contain the characters 0-9, -, ., a-z, and A-Z. This value indicates the publisher that should be used when more than one publisher's packages are present, or when packages are published to the repository and a publisher is not specified.

For repository versions 3 and 4, the following properties can be set for individual publishers in the repository:

publisher/alias

A string that represents the default alias that clients should use when adding a publisher using the repository's configuration data. The first character must be a-z, A-Z, or 0-9. The remainder of the string can only contain the characters 0-9, -, ., a-z, and A-Z.

repository/collection_type

Can have the value core or supplemental, indicating the type of packages offered in this repository.

The core type indicates that the repository contains all of the dependencies declared by packages in the repository. The core type is primarily used for operating system repositories.

The supplemental type indicates that the repository contains packages that rely on or are intended to be used with packages located in another repository.

repository/description

A paragraph of plain text that describes the purpose and contents of the repository.

repository/detailed_url

A URI that represents the location of a document (such as a web page) that provides additional information about the repository.

repository/legal_uris

A list of locations (URIs) for documents that provide additional legal information about the repository.

repository/mirrors

A list of locations (URIs) of repositories that contain a copy of the repository's package content but not the package metadata.

repository/name

A plain text string that contains the name of the repository.

repository/origins

A list of locations (URIs) of repositories that contain a complete copy of the repository's package metadata and content.

repository/refresh_seconds

An integer value that represents the number of seconds clients should wait before checking the repository for updated package data after each update check.

repository/registration_uri

A URI that represents the location of a resource that must be used to obtain credentials for access to the repository. A registration web page is one example.

repository/related_uris

A list of locations (URIs) of repositories that contain packages that users might be interested in.

Properties not documented here, but listed in the output of the get subcommand, are reserved for internal use and should not be set.

pkgrepo help

Display a usage message.

pkgrepo version

Display a unique string that identifies the version of the pkg(5) system. The values produced by the version operation are not sortable and are not safe for comparison beyond equality.

Examples

Example 1 Create a Package Repository

$ pkgrepo create /my/repository

Example 2 Display Information

Display a summary of publishers and the number of packages in a repository.

$ pkgrepo info -s /my/repository
PUBLISHER   PACKAGES STATUS UPDATED
example.com 5        online 2011-07-22T18:09:09.769106Z
$ pkgrepo info -s http://pkg.oracle.com/solaris/release/
PUBLISHER PACKAGES STATUS UPDATED
solaris   3941     online 2010-11-12T19:24:25.967246Z

Example 3 Rebuild Catalogs and Search Data

Rebuild the repository's catalogs and search data.

$ pkgrepo rebuild -s /my/repository

Example 4 Refresh Catalogs and Search Data

Refresh the repository's catalogs and search data.

$ pkgrepo refresh -s /my/repository
$ pkgrepo refresh -s http://example.com/repository

Example 5 Display All Repository Properties

$ pkgrepo get -s /export/repoSolaris11
SECTION    PROPERTY    VALUE
publisher  prefix      solaris
repository description Local\ copy\ of\ the\ Oracle\ Solaris\ 11\ repository
repository name        Oracle\ Solaris\ 11
repository version     4
$ pkgrepo get -s http://pkg.oracle.com/solaris/release/
SECTION    PROPERTY VALUE
deployment content  s11_11-11
deployment pubdate  20111102T222051Z
publisher  prefix   solaris
repository version  4

Example 6 Display All Publisher Properties

$ pkgrepo get -s http://pkg.oracle.com/solaris/release/ -p all
PUBLISHER SECTION    PROPERTY         VALUE
solaris   publisher  alias
solaris   publisher  prefix           solaris
solaris   repository collection-type  core
solaris   repository description      This\ repository\ serves\ the\ Oracle\
Solaris\ 11\ Package\ repository.
solaris   repository legal-uris       ()
solaris   repository mirrors          (http://pkg-cdn1.oracle.com/solaris.release/)
solaris   repository name             Oracle\ Solaris\ 11\ Package\ Repository
solaris   repository origins          ()
solaris   repository refresh-seconds
solaris   repository registration-uri ""
solaris   repository related-uris     ()

Example 7 Set the Default Publisher

$ pkgrepo set -s /my/repository publisher/prefix=example.com

Example 8 Set a Publisher Property

$ pkgrepo set -s /my/repository -p example.com \
repository/origins=http://example.com/repository

Example 9 Add a New Publisher To the Repository

$ pkgrepo add-publisher -s /my/repository example.com

Exit Status

The following exit values are returned:

0

Command succeeded.

1

An error occurred.

2

Invalid command line options were specified.

3

Multiple operations were requested, but only some of them succeeded.

4

No changes were made, nothing to do.

99

An unanticipated exception occurred.

Attributes

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE
ATTRIBUTE VALUE
Availability
package/pkg
Interface Stability
Uncommitted

See Also

pkg(1), pkgrecv(1), pkgsend(1), pkg.depotd(1M), pkg(5)

http://hub.opensolaris.org/bin/view/Project+pkg/