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 May 25, 2014
 18  .Dt PKG-ADD 8
 19  .Os
 20  .Sh NAME
 21  .Nm "pkg add"
 22  .Nd Registers a package and installs it on the system
 23  .Sh SYNOPSIS
 24  .Nm
 25  .Op Fl IAfMq
 26  .Ar pkg-name ...
 27  .Nm
 28  .Op Fl IAfMq
 29  .Ar <protocol>://<path>/<pkg-name> ...
 30  .Pp
 31  .Nm
 32  .Op Cm --{no-scripts,automatic,force,accept-missing,quiet}
 33  .Op Cm --relocate Ar location
 34  .Ar pkg-name ...
 35  .Nm
 36  .Op Cm --{no-scripts,automatic,force,accept-missing,quiet}
 37  .Op Cm --relocate Ar location
 38  .Ar <protocol>://<path>/<pkg-name> ...
 39  .Sh DESCRIPTION
 40  .Nm
 41  installs packages from either a local source or a remote one.
 42  .Pp
 43  When installing from a remote source you need to specify
 44  the protocol to use when fetching the package.
 45  .Pp
 46  Currently supported protocols are FTP, HTTP and HTTPS.
 47  .Pp
 48  Otherwise,
 49  .Nm
 50  will read the file named on the command line.
 51  .Pp
 52  If this is a regular file, and the package to be installed has
 53  unmet dependencies,
 54  .Nm
 55  will search the directory containing
 56  .Ar pkg-name
 57  for suitable pkg archive files to fulfill those dependencies.
 58  If
 59  .Ar pkg-name
 60  is literally
 61  .Pa -
 62  then it will read the package data from stdin.
 63  .Nm
 64  will automatically detect and unpack most common compression formats
 65  based on the content of the data stream it reads, ignoring any
 66  extension the filename may have.
 67  .Pp
 68  If this involves reading from a pipe (including
 69  .Pa stdin ) ,
 70  fifo, socket or some other non-regular form of input stream then
 71  .Nm
 72  will immediately emit an error if
 73  .Ar pkg-name
 74  has unmet dependencies.
 75  .Sh OPTIONS
 76  The following options are supported by
 77  .Nm :
 78  .Bl -tag -width automatic
 79  .It Fl A , Cm --automatic
 80  Mark the installed packages as automatic.
 81  Will be automatically removed if no other packages depend on them.
 82  For more information please refer to
 83  .Xr pkg-autoremove 8 .
 84  .It Fl f , Cm --force
 85  Force the reinstallation of the package if already installed.
 86  .It Fl I , Cm --no-scripts
 87  If any installation scripts (pre-install or post-install) exist for given
 88  packages, do not execute them.
 89  .It Fl M , Cm --accept-missing
 90  Force the installation of the package with missing dependencies.
 91  .It Fl q , Cm --quiet
 92  Force quiet output.
 93  .It Cm --script-no-exec
 94  Do not execute the pre-install and post-install scripts but still log
 95  the scripts in the package database for future reference.
 96  Unlike
 97  .Fl I ,
 98  which prevents scripts from both running and being recorded,
 99  .Cm --script-no-exec
100  only suppresses execution.
101  .It Cm --relocate Ar location
102  Annotates the package as having been relocated to
103  .Pa location ,
104  which is an alternate system root.
105  This is an experimental feature and intended for cross-architecture
106  package management.
107  There is no corresponding single letter option.
108  .Pq DEPRECATED
109  .El
110  .Sh ENVIRONMENT
111  The following environment variables affect the execution of
112  .Nm .
113  See
114  .Xr pkg.conf 5
115  for further description.
116  .Bl -tag -width ".Ev NO_DESCRIPTIONS"
117  .It Ev DEFAULT_ALWAYS_YES
118  .It Ev ASSUME_ALWAYS_YES
119  .It Ev HANDLE_RC_SCRIPTS
120  .It Ev PKG_DBDIR
121  .El
122  .Sh FILES
123  See
124  .Xr pkg.conf 5 .
125  .Sh SEE ALSO
126  .Xr pkg_create 3 ,
127  .Xr pkg_printf 3 ,
128  .Xr pkg_repo_create 3 ,
129  .Xr pkg_repos 3 ,
130  .Xr pkg-keywords 5 ,
131  .Xr pkg-lua-script 5 ,
132  .Xr pkg-repository 5 ,
133  .Xr pkg-script 5 ,
134  .Xr pkg-triggers 5 ,
135  .Xr pkg.conf 5 ,
136  .Xr pkg 8 ,
137  .Xr pkg-alias 8 ,
138  .Xr pkg-annotate 8 ,
139  .Xr pkg-audit 8 ,
140  .Xr pkg-autoremove 8 ,
141  .Xr pkg-check 8 ,
142  .Xr pkg-clean 8 ,
143  .Xr pkg-config 8 ,
144  .Xr pkg-create 8 ,
145  .Xr pkg-delete 8 ,
146  .Xr pkg-fetch 8 ,
147  .Xr pkg-help 8 ,
148  .Xr pkg-info 8 ,
149  .Xr pkg-install 8 ,
150  .Xr pkg-key 8 ,
151  .Xr pkg-lock 8 ,
152  .Xr pkg-plugins 8 ,
153  .Xr pkg-query 8 ,
154  .Xr pkg-register 8 ,
155  .Xr pkg-repo 8 ,
156  .Xr pkg-repositories 8 ,
157  .Xr pkg-rquery 8 ,
158  .Xr pkg-search 8 ,
159  .Xr pkg-set 8 ,
160  .Xr pkg-shell 8 ,
161  .Xr pkg-shlib 8 ,
162  .Xr pkg-ssh 8 ,
163  .Xr pkg-stats 8 ,
164  .Xr pkg-triggers 8 ,
165  .Xr pkg-unregister 8 ,
166  .Xr pkg-update 8 ,
167  .Xr pkg-updating 8 ,
168  .Xr pkg-upgrade 8 ,
169  .Xr pkg-version 8 ,
170  .Xr pkg-which 8