src/mkshortcut/mkshortcut.1

   1 .\"{{{}}}
   2 .\"{{{  Title
   3 .TH MKSHORTCUT 1 "10 Mar 04" "mkshortcut 1.6 (cygutils)" "Cygutils"
   4 .\"}}}
   5 .\"{{{  Name
   6 .SH NAME
   7 mkshortcut \- create a Windows shortcut
   8 .\"}}}
   9 .\"{{{  Synopsis
  10 .SH SYNOPSIS
  11 .B mkshorcut
  12 .RB "[\-\fBa\fP \fIARGS\fP]"
  13 .RB "[\-\fBd\fP \fIDESC\fP]"
  14 .RB "[\-\fBi\fP \fIICONFILE\fP [\-\fBj\fP \fIINT\fP] ]"
  15 .RB "[\-\fBn\fP \fINAME\fP ]"
  16 .RB "[\-\fBs\fP \fInorm|min|max\fP ]"
  17 .RB "[\-\fBw\fP \fIPATH\fP ]"
  18 .RB "[\-A] [\-D|\-P] \fITARGET\fP"
  19 .br
  20 .\"}}}
  21 .\"{{{  Options
  22 .SH OPTIONS
  23
  24 .TP
  25 \fB\-a\fR, \fB\-\-arguments\fP=\fIARGS\fP
  26 Arguments to use (see example below).
  27
  28 .TP
  29 \fB\-d\fR, \fB\-\-desc\fR=\fI"DESC"\fP
  30 Text for description/tooltip (defaults to POSIX path of TARGET). Note that \fI"DESC"\fP can contain spaces, but in that case must be enclosed in quotes.
  31
  32 .TP
  33 \fB\-h\fR, \fB\-\-help\fR
  34 Output usage information (to stdout) and exit.
  35
  36 .TP
  37 \fB\-i\fR, \fB\-\-icon\fR=\fIICONFILE\fP
  38 Specify \fIICONFILE\fP containing the icon to use for the shortcut; defaults to
  39 \fBTARGET\fP. \fIICONFILE\fP must be a full filename, including an extension if
  40 applicable.
  41
  42 .TP
  43 \fB\-j\fR, \fB\-\-iconoffset\fR=\fINUM\fP
  44 Requires \fB\-i\fR. Use \fINUM\fP icon in \fIICONFILE\fP, offset from 0. Defaults
  45 to 0.
  46
  47 .TP
  48 \fB\-n\fR, \fB\-\-name\fR=\fI"NAME"\fP
  49 Name to use for the shortcut file. Note that \fI"NAME"\fP can contain spaces, but in
  50 that case must be enclosed in quotes. The Windows extention \fB.lnk\fP is automatically
  51 appended to \fI"NAME"\fP if not present.
  52
  53 .TP
  54 \fB\-s\fR, \fB\-\-show\fR=\fInorm|min|max\fP
  55 For norm, min, and max the new window will be normal, minimized, and
  56 maximized, respectively.  Note that if you use the properties dialog to
  57 inspect properties of shortcuts for which you request minimized windows
  58 the dialog may indicate that normal windows will be displayed.  Fortunately,
  59 that indicator is often wrong.
  60
  61
  62 .TP
  63 \fB\-w\fR, \fB\-\-workingdir\fR=\fI"PATH"\fP
  64 PATH to use for the working directory (defaults to directory path of TARGET).
  65
  66 .TP
  67 \fB\-v\fR, \fB\-\-version\fR
  68 Output version information (to stdout) and exit.
  69
  70 .TP
  71 \fB\-A\fR, \fB\-\-allusers\fR
  72 Requires either \fB\-D\fR or \fB\-P\fR. Instead of using the current user's \fI"Desktop"\fP
  73 or \fI"Start Menu/Programs"\fP folders, use the \fI"All Users"\fP version. Has no effect on
  74 Win95 without multiple users.
  75
  76 .TP
  77 \fB\-D\fR, \fB\-\-desktop\fR
  78 Instead of creating the shortcut relative to the current directory, create it relative
  79 to the Windows \fI"Desktop"\fP directory. The \fB\-A\fP option can also be used to use
  80 the \fI"All Users/Desktop"\fP directory instead.
  81
  82 .TP
  83 \fB\-P\fR, \fB\-\-smprograms\fR
  84 Instead of creating the shortcut relative to the current directory, create it relative
  85 to the Windows \fI"Start Menu/Programs"\fP directory. The \fB\-A\fP option can also be used
  86 to use the \fI"All Users/Start Menu/Programs"\fP directory instead.
  87
  88 .\"}}}
  89 .SH NOTES
  90 All filename arguments must be in unix (POSIX) format, not in Windows (C:\\) format.
  91 If \fBmkshortcut\fP encounters a syntax error, it will return an exit value of 1 and
  92 output usage information to stderr.
  93 .PP
  94 If you don't need any of \fBmkshortcut\fP's options and just want a simple link to a
  95 file or directory, you might want to just use a symbolic link with \fBln\fP.
  96
  97 .SH EXAMPLES
  98 Create a shortcut to the Cygwin website in the \fI"Start Menu/Programs"\fP directory:
  99 .PP
 100 .nf
 101 $ mkshortcut -P http://www.cygwin.com
 102 .fi
 103 .PP
 104 Create a shortuct to \fBrxvt\fP on the \fI"Desktop"\fP that looks like \fI"Internet
 105 Explorer"\fP but really starts up an interactive \fBbash\fP shell:
 106 .PP
 107 .nf
 108 $ mkshortcut -a '-rv -fn "FixedSys" -e /bin/bash --login -i' \\
 109 -i /c/WINNT/system32/SHELL32.DLL -j 106 -n "Internet Explorer" \\
 110 -D /bin/rxvt
 111 .fi
 112
 113 .SH COPYRIGHT
 114 Copyright (C) 2002 Joshua Daniel Franklin
 115 .PP
 116 \fBmkshortcut\fP is free software: you can redistribute it and/or modify
 117 it under the terms of the GNU General Public License as published by
 118 the Free Software Foundation, either version 3 of the License, or
 119 (at your option) any later version.
 120 .PP
 121 \fBmkshortcut\fP is distributed in the hope that it will be useful,
 122 but WITHOUT ANY WARRANTY; without even the implied warranty of
 123 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 124 GNU General Public License for more details.
 125 .PP
 126 You should have received a copy of the GNU General Public License
 127 along with this program.  If not, see
 128 .BR <http://www.gnu.org/licenses/>.
 129 .PP
 130 See the COPYING file for full license information.
 131 .PP
 132 .\"{{{  Author
 133 .SH AUTHOR
 134 Joshua Daniel Franklin, joshuadfranklin@yahoo.com
 135 .\"}}}
 136 .\"{{{  See also
 137 .SH "SEE ALSO"
 138 .BR ln (1)
 139 .\"}}}