summaryrefslogtreecommitdiffstats
path: root/doc/man/tdefile-plugins/lnkforward.1
blob: 692d6182ab64e88fab05b9c7e8434daf51a86304 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH LNKFORWARD 1 "October 23, 2004"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
lnkforward \- open an URL in a Windows .lnk file under TDE
.SH SYNOPSIS
.B lnkforward
[ \fIgeneric-options\fP ]
[ \fB\-\-map\fP \fIdrive\fP=\fIpath\fP ... ]
\fIURL\fP
.SH DESCRIPTION
\fBlnkforward\fP examines a Windows .lnk file, determines its target and
then opens this target file.  In deciding how to open the target file,
the usual TDE file associations will be used.
.PP
The given URL must include a protocol.  Specifically, if it is simply a
file on the local filesystem, it must be given in the form
\fIfile:/path/to/file.lnk\fP.
.PP
Drive mappings must be supplied (via \-\-map) for any Windows drive
referred to in the .lnk file.  See the OPTIONS section below for details.
.PP
This utility is used by the .lnk tdefile plugin, and is
part of the official TDE add-ons module.
.SH OPTIONS
Below are the lnkforward-specific options.
For a full summary of options, run \fIlnkforward \-\-help\fP.
.TP
\fB\-\-map\fP \fIdrive\fP=\fIpath\fP
Map the given Windows drive to the given path on the local filesystem
(generally its mount point).
This option may be passed multiple times.
.SH EXAMPLE
Suppose that the Windows file \fIc:\\readme.txt.lnk\fP is a link to
\fId:\\foo\\bar.txt\fP.  Then the following command will open the file
\fI/mnt/data/foo/bar.txt\fP in the usual TDE text editor:
.PP
.RS
\fIprompt$\fP
lnkforward \-\-map c=/mnt/windows \-\-map d=/mnt/data /mnt/windows/readme.lnk
.RE
.SH AUTHOR
This utility was written by Martin Koller <m.koller@surfeu.at>.
.br
This manual page was prepared by Ben Burton <bab@debian.org>
for the Debian GNU/Linux system (but may be used by others).