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 "[\-\fBw\fP \fIPATH\fP ]"
  16 .RB "[\-A] [\-D|\-P] \fITARGET\fP"
  17 .br
  18 .\"}}}
  19 .\"{{{  Options
  20 .SH OPTIONS
  21
  22 .TP
  23 \fB\-a\fR, \fB\-\-arguments\fP=\fIARGS\fP
  24 Arguments to use (see example below).
  25
  26 .TP
  27 \fB\-h\fR, \fB\-\-help\fR
  28 Output usage information (to stdout) and exit.
  29
  30 .TP
  31 \fB\-i\fR, \fB\-\-icon\fR=\fIICONFILE\fP
  32 Specify \fIICONFILE\fP containing the icon to use for the shortcut; defaults to
  33 \fBTARGET\fP. \fIICONFILE\fP must be a full filename, including an extension if
  34 applicable.
  35
  36 .TP
  37 \fB\-j\fR, \fB\-\-iconoffset\fR=\fINUM\fP
  38 Requires \fB\-i\fR. Use \fINUM\fP icon in \fIICONFILE\fP, offset from 0. Defaults
  39 to 0.
  40
  41 .TP
  42 \fB\-n\fR, \fB\-\-name\fR=\fI"NAME"\fP
  43 Name to use for the shortcut file. Note that \fI"NAME"\fP can contain spaces, but in
  44 that case must be enclosed in quotes. The Windows extention \fB.lnk\fP is automatically
  45 appended to \fI"NAME"\fP if not present.
  46
  47 .TP
  48 \fB\-w\fR, \fB\-\-workingdir\fR=\fI"PATH"\fP
  49 PATH to use for the working directory (defaults to directory path of TARGET).
  50
  51 .TP
  52 \fB\-v\fR, \fB\-\-version\fR
  53 Output version information (to stdout) and exit.
  54
  55 .TP
  56 \fB\-A\fR, \fB\-\-allusers\fR
  57 Requires either \fB\-D\fR or \fB\-P\fR. Instead of using the current user's \fI"Desktop"\fP
  58 or \fI"Start Menu/Programs"\fP folders, use the \fI"All Users"\fP version. Has no effect on
  59 Win95 without multiple users.
  60
  61 .TP
  62 \fB\-D\fR, \fB\-\-desktop\fR
  63 Instead of creating the shortcut relative to the current directory, create it relative
  64 to the Windows \fI"Desktop"\fP directory. The \fB\-A\fP option can also be used to use
  65 the \fI"All Users/Desktop"\fP directory instead.
  66
  67 .TP
  68 \fB\-P\fR, \fB\-\-smprograms\fR
  69 Instead of creating the shortcut relative to the current directory, create it relative
  70 to the Windows \fI"Start Menu/Programs"\fP directory. The \fB\-A\fP option can also be used
  71 to use the \fI"All Users/Start Menu/Programs"\fP directory instead.
  72
  73 .\"}}}
  74 .SH NOTES
  75 All filename arguments must be in unix (POSIX) format, not in Windows (C:\\) format.
  76 If \fBmkshortcut\fP encounters a syntax error, it will return an exit value of 1 and
  77 output usage information to stderr.
  78 .PP
  79 If you don't need any of \fBmkshortcut\fP's options and just want a simple link to a
  80 file or directory, you might want to just use a symbolic link with \fBln\fP.
  81
  82 .SH EXAMPLES
  83 Create a shortcut to the Cygwin website in the \fI"Start Menu/Programs"\fP directory:
  84 .PP
  85 .nf
  86 $ mkshortcut -P http://www.cygwin.com
  87 .fi
  88 .PP
  89 Create a shortuct to \fBrxvt\fP on the \fI"Desktop"\fP that looks like \fI"Internet
  90 Explorer"\fP but really starts up an interactive \fBbash\fP shell:
  91 .PP
  92 .nf
  93 $ mkshortcut -a '-rv -fn "FixedSys" -e /bin/bash --login -i' \\
  94 -i /c/WINNT/system32/SHELL32.DLL -j 106 -n "Internet Explorer" \\
  95 -D /bin/rxvt
  96 .fi
  97
  98 .SH COPYRIGHT
  99 Copyright (C) 2002 Joshua Daniel Franklin
 100 .PP
 101 \fBmkshortcut\fP is free software; you can redistribute it and/or modify
 102 it under the terms of the GNU General Public License as published by
 103 the Free Software Foundation; either version 2, or (at your option) any
 104 later version.
 105 .PP
 106 \fBmkshortcut\fP is distributed in the hope that it will be useful, but
 107 WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
 108 or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 109 more details.
 110 .PP
 111 You should have received a copy of the GNU General Public License;
 112 see the file COPYING. If not, write to the
 113 Free Software Foundation,
 114 59 Temple Place,
 115 Suite 330, Boston, MA  02111-1307, USA.
 116
 117 .\"{{{  Author
 118 .SH AUTHOR
 119 Joshua Daniel Franklin, joshuadfranklin@yahoo.com
 120 .\"}}}
 121 .\"{{{  See also
 122 .SH "SEE ALSO"
 123 .BR ln (1)
 124 .\"}}}