1DEBCHECKOUT(1) DEBCHECKOUT(1)
2
6 debcheckout - checkout the development repository of a Debian package
7
9 debcheckout [OPTIONS] PACKAGE [DESTDIR]
10 debcheckout [OPTIONS] REPOSITORY_URL [DESTDIR]
11 debcheckout --help
12
14 debcheckout retrieves the information about the Version Control System
15 used to maintain a given Debian package (the PACKAGE argument), and
16 then checks out the latest (potentially unreleased) version of the
17 package from its repository. By default the repository is checked out
18 to the PACKAGE directory; this can be overridden by providing the
19 DESTDIR argument.
20 The information about where the repository is available is expected to
22 be found in Vcs-* fields available in the source package record. For
23 example, the vim package exposes such information with a field like
24 Vcs-Hg: http://hg.debian.org/hg/pkg-vim/vim, you can see it by grepping
25 through apt-cache showsrc vim.
26 If more than one source package record containing Vcs-* fields is
28 available, debcheckout will select the record with the highest version
29 number. Alternatively, a particular version may be selected from those
30 available by specifying the package name as PACKAGE=VERSION.
31 If you already know the URL of a given repository you can invoke
33 debcheckout directly on it, but you will probably need to pass the
34 appropriate -t flag. That is, some heuristics are in use to guess the
35 repository type from the URL; if they fail, you might want to override
36 the guessed type using -t.
37 The currently supported version control systems are: Arch (arch),
39 Bazaar (bzr), CVS (cvs), Darcs (darcs), Git (git), Mercurial (hg) and
40 Subversion (svn).
41
43 GENERAL OPTIONS
44 -a, --auth
46 Work in authenticated mode; this means that for known repositories
47 (mainly those hosted on https://salsa.debian.org) URL rewriting is
48 attempted before checking out, to ensure that the repository can be
49 committed to. For example, for Git repositories hosted on Salsa
50 this means that git@salsa.debian.org:...git will be used instead of
51 https://salsa.debian.org/...git.
52 There are built-in rules for salsa.debian.org and github.com. Other
54 hosts can be configured using DEBCHECKOUT_AUTH_URLS.
55 -d, --details
57 Only print a list of detailed information about the package
58 repository, without checking it out; the output format is a list of
59 fields, each field being a pair of TAB-separated field name and
60 field value. The actual fields depend on the repository type. This
61 action might require a network connection to the remote repository.
62 Also see -p. This option and -p are mutually exclusive.
64 -h, --help
66 Print a detailed help message and exit.
67 -p, --print
69 Only print a summary about package repository information, without
70 checking it out; the output format is TAB-separated with two
71 fields: repository type, repository URL. This action works offline,
72 it only uses "static" information as known by APT's cache.
73 Also see -d. This option and -d are mutually exclusive.
75 -P package, --package package
77 When checking out a repository URL, instead of trying to guess the
78 package name from the URL, use this package name.
79 -t TYPE, --type TYPE
81 Override the repository type (which defaults to some heuristics
82 based on the URL or, in case of heuristic failure, the fallback
83 "git"); should be one of the currently supported repository types.
84 -u USERNAME, --user USERNAME
86 Specify the login name to be used in authenticated mode (see -a).
87 This option implies -a: you don't need to specify both.
88 -f FILE, --file FILE
90 Specify that the named file should be extracted from the repository
91 and placed in the destination directory. May be used more than once
92 to extract multiple files.
93 --source=never|auto|download-only|always
95 Some packages only place the debian directory in version control.
96 debcheckout can retrieve the remaining parts of the source using
97 apt-get source and move the files into the checkout.
98 never
100 Only use the repository.
101 auto (default)
103 If the repository only contains the debian directory, retrieve
104 the source package, unpack it, and also place the .orig.tar.gz
105 file into the current directory. Else, do nothing.
106 download-only
108 Always retrieve the .orig.tar.gz file, but do not unpack it.
109 always
111 Always retrieve the .orig.tar.gz file, and if the repository
112 only contains the debian directory, unpack it.
113 VCS-SPECIFIC OPTIONS
115 GIT-SPECIFIC OPTIONS
117 --git-track BRANCHES
119 Specify a list of remote branches which will be set up for tracking
120 (as in git branch --track, see git-branch(1)) after the remote Git
121 repository has been cloned. The list should be given as a space-
122 separated list of branch names.
123 As a shorthand, the string "*" can be given to require tracking of
125 all remote branches.
126
128 The two configuration files /etc/devscripts.conf and ~/.devscripts are
129 sourced by a shell in that order to set configuration variables.
130 Command line options can be used to override configuration file
131 settings. Environment variable settings are ignored for this purpose.
132 The currently recognised variables are:
133 DEBCHECKOUT_AUTH_URLS
135 This variable should be a space separated list of Perl regular
136 expressions and replacement texts, which must come in pairs: REGEXP
137 TEXT REGEXP TEXT ... and so on. Each pair denotes a substitution
138 which is applied to repository URLs if other built-in means of
139 building URLs for authenticated mode (see -a) have failed.
140 References to matching substrings in the replacement texts are
142 allowed as usual in Perl by the means of $1, $2, ... and so on.
143 This setting is used to configure the "authenticated mode" location
145 for repositories. The Debian repositories on salsa.debian.org are
146 implicitly defined, as is github.com.
147 Here is a sample snippet suitable for the configuration files:
149 DEBCHECKOUT_AUTH_URLS='
151 ^\w+://(svn\.example\.com)/(.*) svn+ssh://$1/srv/svn/$2
152 ^\w+://(git\.example\.com)/(.*) git+ssh://$1/home/git/$2
153 '
154 Note that whitespace is not allowed in either regexps or
156 replacement texts. Also, given that configuration files are sourced
157 by a shell, you probably want to use single quotes around the value
158 of this variable.
159 DEBCHECKOUT_SOURCE
161 This variable determines under what scenarios the associated
162 orig.tar.gz for a package will be downloaded. See the --source
163 option for a description of the values.
164 DEBCHECKOUT_USER
166 This variable sets the username for authenticated mode. It can be
167 overridden with the --user option. Setting this variable does not
168 imply the use of authenticated mode, it still has to be activated
169 with --auth.
170
172 apt-cache(8), Section 6.2.5 of the Debian Developer's Reference (for
173 more information about Vcs-* fields):
174 https://www.debian.org/doc/developers-reference/best-pkging-practices.html#bpp-vcs.
175
177 debcheckout and this manpage have been written by Stefano Zacchiroli
178 <zack@debian.org>.
179Debian Utilities 2023-07-19 DEBCHECKOUT(1)