]> git.donarmstrong.com Git - debhelper.git/blob - dh_link.1
r128: Initial revision
[debhelper.git] / dh_link.1
1 .TH DH_LINK 1 "" "Debhelper Commands" "Debhelper Commands"
2 .SH NAME
3 dh_link \- create symlinks in package build directories
4 .SH SYNOPSIS
5 .B dh_link
6 .I "[debhelper options] [-A] [source destination ...]"
7 .SH "DESCRIPTION"
8 dh_link is a debhelper program that creates symlinks in package build 
9 directories.
10 .P
11 dh_link accepts a list of pairs of source and destination files. The source
12 files are the already existing files that will be symlinked from. The
13 destination files are the symlinks that will be created. There
14 .B must
15 be an equal number of source and destination files specified.
16 .P
17 The list can be specified in two ways. A file named debian/package.links
18 (debian/links may be used for the first binary package in debian/control)
19 can list pairs of files. If you use this file, you should put each pair
20 of files on its own line, and separate the files within the pair with
21 whitespace. Also, pairs of files can be specified as parameters - these
22 pairs will only be created in the package build directory of the first
23 ackage dh_link is told to act on. By default, this is the first binary 
24 package in debian/control, but if you use -p, -i, or -a flags, it will be 
25 the first package specified by those flags.
26 .P
27 Be sure to only use file names relative to the package build
28 directory. Ie, "/usr/bin/foo" should not be used, use "usr/bin/foo" instead.
29 Also, be sure you
30 .B do
31 specify the full filename to both the source and destination files (unlike
32 you would do if you were using something like
33 .BR ln (1)
34 )
35 .P
36 dh_link will generate symlinks that comply with debian policy - absolute
37 when policy says they should be absolute, and relative links with as short a
38 path as possible. It will also create any subdirectories it needs to to put
39 the symlinks in.
40 .SH OPTIONS
41 .TP
42 .B debhelper options
43 See
44 .BR debhelper (1)
45 for a list of options common to all debhelper commands.
46 .TP
47 .B \-A, \--all
48 Create any links specified by command line parameters in ALL packages
49 acted on, not just the first.
50 .TP
51 .B source destination ...
52 Create a file named "destination" as a link to a file named "source". Do 
53 this in the package build directory of the first package acted on. 
54 (Or in all packages if -A is specified.)
55 .SH EXAMPLES
56 .TP
57 .B dh_link usr/man/man1/foo.1 usr/man/man1/bar.1
58 Make bar.1 be a symlink to foo.1
59 .TP
60 .B dh_link var/lib/foo usr/lib/foo usr/X11R6/man/man1/foo.1x usr/man/man1/bar.1
61 Make /usr/lib/foo/ be a link to /var/lib/foo/, and bar.1 be a symlink to the
62 X man page foo.1x
63 .SH ENVIRONMENT
64 See
65 .BR debhelper (1)
66 for a list of environment variables that affect all debhelper commands.
67 .SH "SEE ALSO"
68 .BR debhelper (1)
69 .SH BUGS
70 It's impossible to specify filenames with spaces or other whitespace in them
71 in debian/links file. This is more a historical design flaw than a bug.
72 .SH "CONFORMS TO"
73 Debian policy, version 2.5.0.0
74 .SH AUTHOR
75 Joey Hess <joeyh@master.debian.org>