summaryrefslogtreecommitdiffstats
path: root/doc/man/tdefile-plugins
diff options
context:
space:
mode:
authorMichele Calgaro <michele.calgaro@yahoo.it>2022-06-02 20:15:14 +0900
committerMichele Calgaro <michele.calgaro@yahoo.it>2022-06-03 17:39:00 +0900
commit38d555ae68d01f3481af5c7562ef32228fb0e8ab (patch)
treed73e1a2801a1b5fc7ea748b1240dcbe13199b4a4 /doc/man/tdefile-plugins
parentdb5b0a4907f3ebe5ad4fec7f81c38bbb104e911e (diff)
downloadtdeaddons-38d555ae68d01f3481af5c7562ef32228fb0e8ab.tar.gz
tdeaddons-38d555ae68d01f3481af5c7562ef32228fb0e8ab.zip
Add man pages for TDE applications.
Signed-off-by: Michele Calgaro <michele.calgaro@yahoo.it> (cherry picked from commit 825599fcfff1d8e78368e2dfd9537499f48313a4)
Diffstat (limited to 'doc/man/tdefile-plugins')
-rw-r--r--doc/man/tdefile-plugins/CMakeLists.txt7
-rw-r--r--doc/man/tdefile-plugins/lnkforward.160
2 files changed, 67 insertions, 0 deletions
diff --git a/doc/man/tdefile-plugins/CMakeLists.txt b/doc/man/tdefile-plugins/CMakeLists.txt
new file mode 100644
index 0000000..24ccd70
--- /dev/null
+++ b/doc/man/tdefile-plugins/CMakeLists.txt
@@ -0,0 +1,7 @@
+file( GLOB _man_files RELATIVE ${CMAKE_CURRENT_SOURCE_DIR} *.1 )
+
+INSTALL(
+ FILES ${_man_files}
+ DESTINATION ${MAN_INSTALL_DIR}/man1
+ COMPONENT doc
+)
diff --git a/doc/man/tdefile-plugins/lnkforward.1 b/doc/man/tdefile-plugins/lnkforward.1
new file mode 100644
index 0000000..692d618
--- /dev/null
+++ b/doc/man/tdefile-plugins/lnkforward.1
@@ -0,0 +1,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).