path: root/manual
diff options
authorSebastian Leonhardt <>2017-09-15 23:43:41 +0200
committerSebastian Leonhardt <>2019-08-11 22:26:49 +0200
commit5c701b02809ffeec2e9de50e89995dbb85cd7a62 (patch)
tree823dd1444789ef1ebff521cc7d6ca36e1c4f740a /manual
parenta9a891b47b828c20b5b3d3e29983e66d48419377 (diff)
Add support for Windows shortcuts (*.lnk files)
Supports only relative links across the same volume. Change-Id: I4f61bb9d5f2385d5b15d2b9d9a3f814a7ac85b54
Diffstat (limited to 'manual')
3 files changed, 22 insertions, 0 deletions
diff --git a/manual/plugins/main.tex b/manual/plugins/main.tex
index c07d106024..96326cbffe 100644
--- a/manual/plugins/main.tex
+++ b/manual/plugins/main.tex
@@ -165,6 +165,7 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
{\textbf{Viewer Plugin}& \textbf{Associated filetype(s)} & \textbf{Context Menu only}}%
Shortcuts & \fname{.link} & \\
+ MS Windows shortcuts & \fname{.lnk} & \\
Chip-8 Emulator & \fname{.ch8} & \\
Frotz & \fname{.z1} to \fname{.z8} & \\
Image Viewer & \fname{.bmp, .jpg, .jpeg, .png\opt{lcd_color}{, .ppm}} & \\
@@ -200,6 +201,8 @@ option from the \setting{Context Menu} (see \reference{ref:Contextmenu}).}
diff --git a/manual/plugins/shortcuts.tex b/manual/plugins/shortcuts.tex
index 2cca5f773f..813bdeaf56 100644
--- a/manual/plugins/shortcuts.tex
+++ b/manual/plugins/shortcuts.tex
@@ -8,6 +8,10 @@ line containing the name of the file or the directory you want to quickly
jump to. All names should be full absolute names, i.e. they should start
with a \fname{/}. Directory names should also end with a \fname{/}.
+\note{This plugin cannot read Microsoft Windows shortcuts (\fname{.lnk}
+files). These are handled by a separate plugin; see
\subsubsection{How to create \fname{.link} files}
You can use your favourite text editor to create a \fname{.link} file on the
diff --git a/manual/plugins/winshortcuts.tex b/manual/plugins/winshortcuts.tex
new file mode 100644
index 0000000000..a3a4063b6f
--- /dev/null
+++ b/manual/plugins/winshortcuts.tex
@@ -0,0 +1,15 @@
+\subsection{Windows Shortcuts}
+This plugin follows Microsoft Windows Explorer shortcuts (\fname{.lnk} files).
+In Rockbox, these types of shortcuts will show up as \fname{.lnk} files. To
+follow a shortcut, just ``play'' a \fname{.lnk} file from the file browser.
+The plugin will navigate the file browser to the linked file (which
+will be highlighted) or directory (which will be opened). Linked files will
+not be automatically opened; you must do this manually.
+Only relative links across the same volume are supported.
+\note{You may like to use native Rockbox shortcuts instead. These can be
+ created from within Rockbox itself and have advanced capabilities.
+ See \reference{ref:Shortcutsplugin}.}