]> cygwin.com Git - cygwin-apps/cygutils.git/blobdiff - src/mkshortcut/mkshortcut.1
Add -s option to mkshortcut
[cygwin-apps/cygutils.git] / src / mkshortcut / mkshortcut.1
index 70828f71cdb6b860e9c9ea54a3e3d151b02cd29d..0a76e0e94ef7de617ef61e4936a157303596dc92 100644 (file)
-.\"{{{}}}\r
-.\"{{{  Title\r
-.TH MKSHORTCUT 1 "23 Feb 2002" "mkshortcut 1.01 (cygutils)" "Cygutils"\r
-.\"}}}\r
-.\"{{{  Name\r
-.SH NAME\r
-mkshortcut \- create a Windows shortcut\r
-.\"}}}\r
-.\"{{{  Synopsis\r
-.SH SYNOPSIS\r
-.B mkshorcut\r
-.RB "\-h|\-v" \r
-.br\r
-.B mkshorcut\r
-.RB "[\-\fBa\fP \fIARGS\fP]"\r
-.RB "[\-\fBi\fP \fIiconfile\fP [\-\fBj\fP \fIoffset\fP] ]"\r
-.RB "[\-\fBn\fP \fIname\fP ]"\r
-.RB "[\-A] [\-D|\-P] \fITARGET\fP"\r
-.br\r
-.\"}}}\r
-.\"{{{  Description\r
-.SH DESCRIPTION\r
-.B mkshortcut\r
-is a command-line tool for creating Windows shortcut files (also known as\r
-OLE links). It supports actions such as specifying arguments and setting the \r
-icon to use for the shortcut. It can be easily run from a script or batch\r
-file for non-interactive use.\r
-.PP\r
-.B TARGET\r
-may be a file in the current directory, a full unix (POSIX) path, or a URL\r
-in the form \fBhttp://www.cygwin.com\fP\r
-.\"}}}\r
-.\"{{{  Options\r
-.SH OPTIONS\r
-\r
-.TP \r
-\fB\-a\fR, \fB\-\-arguments\fP=\fIARGS\fP\r
-Arguments to use (see example below).\r
-\r
-.TP \r
-\fB\-h\fR, \fB\-\-help\fR\r
-Output usage information (to stdout) and exit.\r
-\r
-.TP \r
-\fB\-i\fR, \fB\-\-icon\fR=\fIICONFILE\fP\r
-Specify \fIICONFILE\fP containing the icon to use for the shortcut; defaults to\r
-\fBTARGET\fP. \fIICONFILE\fP must be a full filename, including an extension if \r
-applicable.\r
-\r
-.TP \r
-\fB\-j\fR, \fB\-\-iconoffset\fR=\fINUM\fP\r
-Requires \fB\-i\fR. Use \fINUM\fP icon in \fIICONFILE\fP, offset from 0. Defaults\r
-to 0.\r
-\r
-.TP \r
-\fB\-n\fR, \fB\-\-name\fR=\fI"NAME"\fP\r
-Name to use for the shortcut file. Note that \fI"NAME"\fP can contain spaces, but in\r
-that case must be enclosed in quotes. The Windows extention \fB.lnk\fP is automatically\r
-appended to \fI"NAME"\fP if not present.\r
-\r
-.TP\r
-\fB\-v\fR, \fB\-\-version\fR\r
-Output version information (to stdout) and exit.\r
-\r
-.TP \r
-\fB\-A\fR, \fB\-\-allusers\fR\r
-Requires either \fB\-D\fR or \fB\-P\fR. Instead of using the current user's \fI"Desktop"\fP \r
-or \fI"Start Menu/Programs"\fP folders, use the \fI"All Users"\fP version. Has no effect on\r
-Win95 without multiple users.\r
-\r
-.TP \r
-\fB\-D\fR, \fB\-\-desktop\fR\r
-Instead of creating the shortcut relative to the current directory, create it relative\r
-to the Windows \fI"Desktop"\fP directory. The \fB\-A\fP option can also be used to use\r
-the \fI"All Users/Desktop"\fP directory instead.\r
-\r
-.TP \r
-\fB\-P\fR, \fB\-\-smprograms\fR\r
-Instead of creating the shortcut relative to the current directory, create it relative\r
-to the Windows \fI"Start Menu/Programs"\fP directory. The \fB\-A\fP option can also be used \r
-to use the \fI"All Users/Start Menu/Programs"\fP directory instead.\r
-\r
-.\"}}}\r
-.SH NOTES\r
-All filename arguments must be in unix (POSIX) format, not in Windows (C:\\) format.\r
-If \fBmkshortcut\fP encounters a syntax error, it will return an exit value of 1 and \r
-output usage information to stderr.\r
-.PP\r
-If you don't need any of \fBmkshortcut\fP's options and just want a simple link to a\r
-file or directory, you might want to just use a symbolic link with \fBln\fP.\r
-\r
-.SH EXAMPLES\r
-Create a shortcut to the Cygwin website in the \fI"Start Menu/Programs"\fP directory:\r
-.PP\r
-.nf\r
-$ mkshortcut -P http://www.cygwin.com\r
-.fi\r
-.PP\r
-Create a shortuct to \fBrxvt\fP on the \fI"Desktop"\fP that looks like \fI"Internet \r
-Explorer"\fP but really starts up an interactive \fBbash\fP shell:\r
-.PP\r
-.nf\r
-$ mkshortcut -a '-rv -fn "FixedSys" -e /bin/bash --login -i' \\\r
--i /c/WINNT/system32/SHELL32.DLL -j 106 -n "Internet Explorer" \\\r
--D /bin/rxvt\r
-.fi\r
-\r
-.SH COPYRIGHT\r
-Copyright (C) 2002 Joshua Daniel Franklin\r
-.PP\r
-\fBmkshortcut\fP is free software; you can redistribute it and/or modify\r
-it under the terms of the GNU General Public License as published by\r
-the Free Software Foundation; either version 2, or (at your option) any \r
-later version.\r
-.PP\r
-\fBmkshortcut\fP is distributed in the hope that it will be useful, but\r
-WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY\r
-or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for \r
-more details.\r
-.PP\r
-You should have received a copy of the GNU General Public License; \r
-see the file COPYING. If not, write to the \r
-Free Software Foundation, \r
-59 Temple Place,\r
-Suite 330, Boston, MA  02111-1307, USA.\r
-\r
-.\"{{{  Author\r
-.SH AUTHOR\r
-Joshua Daniel Franklin, joshuadfranklin@yahoo.com\r
-.\"}}}\r
-.\"{{{  See also\r
-.SH "SEE ALSO"\r
-.BR ln (1)\r
-.\"}}}\r
+.\"{{{}}}
+.\"{{{  Title
+.TH MKSHORTCUT 1 "21 Oct 03" "mkshortcut 1.5 (cygutils)" "Cygutils"
+.\"}}}
+.\"{{{  Name
+.SH NAME
+mkshortcut \- create a Windows shortcut
+.\"}}}
+.\"{{{  Synopsis
+.SH SYNOPSIS
+.B mkshorcut
+.RB "[\-\fBa\fP \fIARGS\fP]"
+.RB "[\-\fBi\fP \fIiconfile\fP [\-\fBj\fP \fIINT\fP] ]"
+.RB "[\-\fBn\fP \fINAME\fP ]"
+.RB "[\-\fBs\fP \fInorm|min|max\fP ]"
+.RB "[\-\fBw\fP \fIPATH\fP ]"
+.RB "[\-A] [\-D|\-P] \fITARGET\fP"
+.br
+.\"}}}
+.\"{{{  Options
+.SH OPTIONS
+
+.TP 
+\fB\-a\fR, \fB\-\-arguments\fP=\fIARGS\fP
+Arguments to use (see example below).
+
+.TP 
+\fB\-h\fR, \fB\-\-help\fR
+Output usage information (to stdout) and exit.
+
+.TP 
+\fB\-i\fR, \fB\-\-icon\fR=\fIICONFILE\fP
+Specify \fIICONFILE\fP containing the icon to use for the shortcut; defaults to
+\fBTARGET\fP. \fIICONFILE\fP must be a full filename, including an extension if 
+applicable.
+
+.TP 
+\fB\-j\fR, \fB\-\-iconoffset\fR=\fINUM\fP
+Requires \fB\-i\fR. Use \fINUM\fP icon in \fIICONFILE\fP, offset from 0. Defaults
+to 0.
+
+.TP 
+\fB\-n\fR, \fB\-\-name\fR=\fI"NAME"\fP
+Name to use for the shortcut file. Note that \fI"NAME"\fP can contain spaces, but in
+that case must be enclosed in quotes. The Windows extention \fB.lnk\fP is automatically
+appended to \fI"NAME"\fP if not present.
+
+.TP 
+\fB\-s\fR, \fB\-\-show\fR=\fInorm|min|max\fP
+For norm, min, and max the new window will be normal, minimized, and 
+maximized, respectively.  Note that if you use the properties dialog to
+inspect properties of shortcuts for which you request minimized windows 
+the dialog may indicate that normal windows will be displayed.  Fortunately,
+that indicator is often wrong.
+
+
+.TP 
+\fB\-w\fR, \fB\-\-workingdir\fR=\fI"PATH"\fP
+PATH to use for the working directory (defaults to directory path of TARGET).
+
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Output version information (to stdout) and exit.
+
+.TP 
+\fB\-A\fR, \fB\-\-allusers\fR
+Requires either \fB\-D\fR or \fB\-P\fR. Instead of using the current user's \fI"Desktop"\fP 
+or \fI"Start Menu/Programs"\fP folders, use the \fI"All Users"\fP version. Has no effect on
+Win95 without multiple users.
+
+.TP 
+\fB\-D\fR, \fB\-\-desktop\fR
+Instead of creating the shortcut relative to the current directory, create it relative
+to the Windows \fI"Desktop"\fP directory. The \fB\-A\fP option can also be used to use
+the \fI"All Users/Desktop"\fP directory instead.
+
+.TP 
+\fB\-P\fR, \fB\-\-smprograms\fR
+Instead of creating the shortcut relative to the current directory, create it relative
+to the Windows \fI"Start Menu/Programs"\fP directory. The \fB\-A\fP option can also be used 
+to use the \fI"All Users/Start Menu/Programs"\fP directory instead.
+
+.\"}}}
+.SH NOTES
+All filename arguments must be in unix (POSIX) format, not in Windows (C:\\) format.
+If \fBmkshortcut\fP encounters a syntax error, it will return an exit value of 1 and 
+output usage information to stderr.
+.PP
+If you don't need any of \fBmkshortcut\fP's options and just want a simple link to a
+file or directory, you might want to just use a symbolic link with \fBln\fP.
+
+.SH EXAMPLES
+Create a shortcut to the Cygwin website in the \fI"Start Menu/Programs"\fP directory:
+.PP
+.nf
+$ mkshortcut -P http://www.cygwin.com
+.fi
+.PP
+Create a shortuct to \fBrxvt\fP on the \fI"Desktop"\fP that looks like \fI"Internet 
+Explorer"\fP but really starts up an interactive \fBbash\fP shell:
+.PP
+.nf
+$ mkshortcut -a '-rv -fn "FixedSys" -e /bin/bash --login -i' \\
+-i /c/WINNT/system32/SHELL32.DLL -j 106 -n "Internet Explorer" \\
+-D /bin/rxvt
+.fi
+
+.SH COPYRIGHT
+Copyright (C) 2002 Joshua Daniel Franklin
+.PP
+\fBmkshortcut\fP is free software; you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation; either version 2, or (at your option) any 
+later version.
+.PP
+\fBmkshortcut\fP is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 
+more details.
+.PP
+You should have received a copy of the GNU General Public License; 
+see the file COPYING. If not, write to the 
+Free Software Foundation, 
+59 Temple Place,
+Suite 330, Boston, MA  02111-1307, USA.
+
+.\"{{{  Author
+.SH AUTHOR
+Joshua Daniel Franklin, joshuadfranklin@yahoo.com
+.\"}}}
+.\"{{{  See also
+.SH "SEE ALSO"
+.BR ln (1)
+.\"}}}
This page took 0.034346 seconds and 5 git commands to generate.