pkg-fetch.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 September 20, 2015 18 .Dt PKG-FETCH 8 19 .Os 20 .Sh NAME 21 .Nm "pkg fetch" 22 .Nd fetch remote packages 23 .Sh SYNOPSIS 24 .Nm 25 .Op Fl r Ar reponame ... 26 .Op Fl dqUy 27 .Op Fl Cgix 28 .Ar pkg-name 29 .Op ... 30 .Nm 31 .Op Fl r Ar reponame ... 32 .Op Fl o Ar destdir 33 .Op Fl dqsUy 34 .Fl a 35 .Nm 36 .Op Fl r Ar reponame ... 37 .Op Fl dqUy 38 .Fl u 39 .Pp 40 .Nm 41 .Op Cm --repository Ar reponame ... 42 .Op Cm --output Ar destdir 43 .Op Cm --{dependencies,quiet,symlink,no-repo-update,yes} 44 .Op Cm --{case-sensitive,glob,case-insensitive,regex} 45 .Ar pkg-name 46 .Op ... 47 .Nm 48 .Op Cm --repository Ar reponame ... 49 .Op Cm --{dependencies,quiet,symlink,no-repo-update,yes} 50 .Cm --all 51 .Nm 52 .Op Cm --repository Ar reponame ... 53 .Op Cm --{dependencies,quiet,no-repo-update,yes} 54 .Cm --available-updates 55 .Sh DESCRIPTION 56 .Nm 57 is used to download binary packages from a remote repository. 58 .Pp 59 One or more packages, or patterns, can be specified. 60 .Pp 61 Package repository catalogues will be automatically updated whenever 62 .Nm 63 is run by a user ID with write access to the package database, 64 unless disabled by the 65 .Fl U 66 flag or setting 67 .Cm REPO_AUTOUPDATE 68 to 69 .Sy NO 70 in 71 .Xr pkg.conf 5 . 72 .Sh OPTIONS 73 The following options are supported by 74 .Nm : 75 .Bl -tag -width dependencies 76 .It Fl a , Cm --all 77 Fetch all packages. 78 .It Fl o Ar destdir , Cm --output Ar destdir 79 Place files in a sub-directory called All of the specified directory. 80 In this mode, packages are fetched for 81 distribution instead of placing them into the internal cache. 82 .It Fl C , Cm --case-sensitive 83 Make the standard or the regular expression 84 .Fl ( x ) 85 matching against 86 .Ar pkg-name 87 case sensitive. 88 .It Fl d , Cm --dependencies 89 Fetch the package and its dependencies as well. 90 .It Fl g , Cm --glob 91 Treat 92 .Ar pkg-name 93 as a shell glob pattern. 94 .It Fl i , Cm --case-insensitive 95 Make the standard or regular expression 96 .Fl ( x ) 97 matching against 98 .Ar pkg-name 99 case insensitive. 100 This is the default, unless modified by setting 101 .Ev CASE_SENSITIVE_MATCH 102 to true in 103 .Pa pkg.conf . 104 .It Fl q , Cm --quiet 105 Quiet mode. 106 Show less output. 107 .It Fl r Ar reponame , Cm --repository Ar reponame 108 Fetches packages from the given 109 .Ar reponame 110 if multiple repo support is enabled. 111 This option can be specified multiple times to use several repositories. 112 See 113 .Xr pkg.conf 5 . 114 .It Fl s , Cm --symlink 115 Create a symlink to the fetched package in the 116 .Pa All 117 directory when using 118 .Fl o 119 to fetch packages for distribution. 120 This is useful when the remote repository stores packages in a hashed 121 directory structure 122 .Pa ( All/Hashed/xx/ ) 123 but local tools expect packages directly in 124 .Pa All/ . 125 .It Fl u , Cm --available-updates 126 Fetch all available updates for the currently installed packages. 127 .It Fl U , Cm --no-repo-update 128 Suppress the automatic update of the local copy of the repository catalogue 129 from remote. 130 Automatic repository catalogue updates are only attempted when the 131 effective UID of the process has write access to the package database. 132 Otherwise they are silently ignored. 133 .It Fl x , Cm --regex 134 Treat 135 .Ar pkg-name 136 as a regular expression according to the "modern" or "extended" syntax 137 of 138 .Xr re_format 7 . 139 .It Fl y , Cm --yes 140 Assume yes when asked for confirmation before fetching packages. 141 .El 142 .Sh ENVIRONMENT 143 The following environment variables affect the execution of 144 .Nm : 145 .Bl -tag -width ".Ev PKG_REPO_SYMLINK" 146 .It Ev PKG_DBDIR 147 .It Ev CASE_SENSITIVE_MATCH 148 .It Ev PKG_REPO_SYMLINK 149 If set, enables symlink creation when fetching packages with 150 .Fl o , 151 equivalent to specifying 152 .Fl s . 153 .El 154 .Pp 155 See 156 .Xr pkg.conf 5 157 for additional environment variables that control behaviour. 158 .Sh FILES 159 See 160 .Xr pkg.conf 5 . 161 .Sh SEE ALSO 162 .Xr pkg_create 3 , 163 .Xr pkg_printf 3 , 164 .Xr pkg_repo_create 3 , 165 .Xr pkg_repos 3 , 166 .Xr pkg-keywords 5 , 167 .Xr pkg-lua-script 5 , 168 .Xr pkg-repository 5 , 169 .Xr pkg-script 5 , 170 .Xr pkg-triggers 5 , 171 .Xr pkg.conf 5 , 172 .Xr pkg 8 , 173 .Xr pkg-add 8 , 174 .Xr pkg-alias 8 , 175 .Xr pkg-annotate 8 , 176 .Xr pkg-audit 8 , 177 .Xr pkg-autoremove 8 , 178 .Xr pkg-check 8 , 179 .Xr pkg-clean 8 , 180 .Xr pkg-config 8 , 181 .Xr pkg-create 8 , 182 .Xr pkg-delete 8 , 183 .Xr pkg-help 8 , 184 .Xr pkg-info 8 , 185 .Xr pkg-install 8 , 186 .Xr pkg-key 8 , 187 .Xr pkg-lock 8 , 188 .Xr pkg-plugins 8 , 189 .Xr pkg-query 8 , 190 .Xr pkg-register 8 , 191 .Xr pkg-repo 8 , 192 .Xr pkg-repositories 8 , 193 .Xr pkg-rquery 8 , 194 .Xr pkg-search 8 , 195 .Xr pkg-set 8 , 196 .Xr pkg-shell 8 , 197 .Xr pkg-shlib 8 , 198 .Xr pkg-ssh 8 , 199 .Xr pkg-stats 8 , 200 .Xr pkg-triggers 8 , 201 .Xr pkg-unregister 8 , 202 .Xr pkg-update 8 , 203 .Xr pkg-updating 8 , 204 .Xr pkg-upgrade 8 , 205 .Xr pkg-version 8 , 206 .Xr pkg-which 8