src/mkshortcut/mkshortcut.1

   1 .\"{{{}}}
   2 .\"{{{  Title
   3 .TH MKSHORTCUT 1 "21 Oct 03" "mkshortcut 1.5 (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 "[\-\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"
  18 .br
  19 .\"}}}
  20 .\"{{{  Options
  21 .SH OPTIONS
  22
  23 .TP
  24 \fB\-a\fR, \fB\-\-arguments\fP=\fIARGS\fP
  25 Arguments to use (see example below).
  26
  27 .TP
  28 \fB\-h\fR, \fB\-\-help\fR
  29 Output usage information (to stdout) and exit.
  30
  31 .TP
  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
  35 applicable.
  36
  37 .TP
  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
  40 to 0.
  41
  42 .TP
  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.
  47
  48 .TP
  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.
  55
  56
  57 .TP
  58 \fB\-w\fR, \fB\-\-workingdir\fR=\fI"PATH"\fP
  59 PATH to use for the working directory (defaults to directory path of TARGET).
  60
  61 .TP
  62 \fB\-v\fR, \fB\-\-version\fR
  63 Output version information (to stdout) and exit.
  64
  65 .TP
  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.
  70
  71 .TP
  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.
  76
  77 .TP
  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.
  82
  83 .\"}}}
  84 .SH NOTES
  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.
  88 .PP
  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.
  91
  92 .SH EXAMPLES
  93 Create a shortcut to the Cygwin website in the \fI"Start Menu/Programs"\fP directory:
  94 .PP
  95 .nf
  96 $ mkshortcut -P http://www.cygwin.com
  97 .fi
  98 .PP
  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:
 101 .PP
 102 .nf
 103 $ mkshortcut -a '-rv -fn "FixedSys" -e /bin/bash --login -i' \\
 104 -i /c/WINNT/system32/SHELL32.DLL -j 106 -n "Internet Explorer" \\
 105 -D /bin/rxvt
 106 .fi
 107
 108 .SH COPYRIGHT
 109 Copyright (C) 2002 Joshua Daniel Franklin
 110 .PP
 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
 114 later version.
 115 .PP
 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
 119 more details.
 120 .PP
 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,
 124 59 Temple Place,
 125 Suite 330, Boston, MA  02111-1307, USA.
 126
 127 .\"{{{  Author
 128 .SH AUTHOR
 129 Joshua Daniel Franklin, joshuadfranklin@yahoo.com
 130 .\"}}}
 131 .\"{{{  See also
 132 .SH "SEE ALSO"
 133 .BR ln (1)
 134 .\"}}}