3 .TH MKSHORTCUT 1 "21 Oct 03" "mkshortcut 1.5 (cygutils)" "Cygutils"
7 mkshortcut \- create a Windows shortcut
12 .RB "[\-\fBa\fP \fIARGS\fP]"
13 .RB "[\-\fBi\fP \fIiconfile\fP [\-\fBj\fP \fIINT\fP] ]"
14 .RB "[\-\fBn\fP \fINAME\fP ]"
15 .RB "[\-\fBs\fP \fInorm|min|max\fP ]"
16 .RB "[\-\fBw\fP \fIPATH\fP ]"
17 .RB "[\-A] [\-D|\-P] \fITARGET\fP"
24 \fB\-a\fR, \fB\-\-arguments\fP=\fIARGS\fP
25 Arguments to use (see example below).
28 \fB\-h\fR, \fB\-\-help\fR
29 Output usage information (to stdout) and exit.
32 \fB\-i\fR, \fB\-\-icon\fR=\fIICONFILE\fP
33 Specify \fIICONFILE\fP containing the icon to use for the shortcut; defaults to
34 \fBTARGET\fP. \fIICONFILE\fP must be a full filename, including an extension if
38 \fB\-j\fR, \fB\-\-iconoffset\fR=\fINUM\fP
39 Requires \fB\-i\fR. Use \fINUM\fP icon in \fIICONFILE\fP, offset from 0. Defaults
43 \fB\-n\fR, \fB\-\-name\fR=\fI"NAME"\fP
44 Name to use for the shortcut file. Note that \fI"NAME"\fP can contain spaces, but in
45 that case must be enclosed in quotes. The Windows extention \fB.lnk\fP is automatically
46 appended to \fI"NAME"\fP if not present.
49 \fB\-s\fR, \fB\-\-show\fR=\fInorm|min|max\fP
50 For norm, min, and max the new window will be normal, minimized, and
51 maximized, respectively. Note that if you use the properties dialog to
52 inspect properties of shortcuts for which you request minimized windows
53 the dialog may indicate that normal windows will be displayed. Fortunately,
54 that indicator is often wrong.
58 \fB\-w\fR, \fB\-\-workingdir\fR=\fI"PATH"\fP
59 PATH to use for the working directory (defaults to directory path of TARGET).
62 \fB\-v\fR, \fB\-\-version\fR
63 Output version information (to stdout) and exit.
66 \fB\-A\fR, \fB\-\-allusers\fR
67 Requires either \fB\-D\fR or \fB\-P\fR. Instead of using the current user's \fI"Desktop"\fP
68 or \fI"Start Menu/Programs"\fP folders, use the \fI"All Users"\fP version. Has no effect on
69 Win95 without multiple users.
72 \fB\-D\fR, \fB\-\-desktop\fR
73 Instead of creating the shortcut relative to the current directory, create it relative
74 to the Windows \fI"Desktop"\fP directory. The \fB\-A\fP option can also be used to use
75 the \fI"All Users/Desktop"\fP directory instead.
78 \fB\-P\fR, \fB\-\-smprograms\fR
79 Instead of creating the shortcut relative to the current directory, create it relative
80 to the Windows \fI"Start Menu/Programs"\fP directory. The \fB\-A\fP option can also be used
81 to use the \fI"All Users/Start Menu/Programs"\fP directory instead.
85 All filename arguments must be in unix (POSIX) format, not in Windows (C:\\) format.
86 If \fBmkshortcut\fP encounters a syntax error, it will return an exit value of 1 and
87 output usage information to stderr.
89 If you don't need any of \fBmkshortcut\fP's options and just want a simple link to a
90 file or directory, you might want to just use a symbolic link with \fBln\fP.
93 Create a shortcut to the Cygwin website in the \fI"Start Menu/Programs"\fP directory:
96 $ mkshortcut -P http://www.cygwin.com
99 Create a shortuct to \fBrxvt\fP on the \fI"Desktop"\fP that looks like \fI"Internet
100 Explorer"\fP but really starts up an interactive \fBbash\fP shell:
103 $ mkshortcut -a '-rv -fn "FixedSys" -e /bin/bash --login -i' \\
104 -i /c/WINNT/system32/SHELL32.DLL -j 106 -n "Internet Explorer" \\
109 Copyright (C) 2002 Joshua Daniel Franklin
111 \fBmkshortcut\fP is free software; you can redistribute it and/or modify
112 it under the terms of the GNU General Public License as published by
113 the Free Software Foundation; either version 2, or (at your option) any
116 \fBmkshortcut\fP is distributed in the hope that it will be useful, but
117 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
118 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
121 You should have received a copy of the GNU General Public License;
122 see the file COPYING. If not, write to the
123 Free Software Foundation,
125 Suite 330, Boston, MA 02111-1307, USA.
129 Joshua Daniel Franklin, joshuadfranklin@yahoo.com