src/cygstart/cygstart.1

   1 .\"{{{}}}
   2 .\"{{{  Title
   3 .TH CYGSTART 1 "14 Mar 2002" "cygstart 1.0 (cygutils)" "Cygutils"
   4 .\"}}}
   5 .\"{{{  Name
   6 .SH NAME
   7 cygstart \- start a program or open a file or URL
   8 .\"}}}
   9 .\"{{{  Synopsis
  10 .SH SYNOPSIS
  11 .B cygstart
  12 .RB "[\-\fBoxefp?\fP] [\-\fBa\fP \fIaction\fP] [\-\fBd\fP \fIdirectory\fP]"
  13 .RB "[\-\-\fBhide\fP] [\-\-\fBmaximize\fP] [\-\-\fBminimize\fP]"
  14 .RB "[\-\-\fBrestore\fP] [\-\-\fBshow\fP] [\-\-\fBshowmaximized\fP]"
  15 .RB "[\-\-\fBshowminimized\fP] [\-\-\fBshowminnoactive\fP]"
  16 .RB "[\-\-\fBshowna\fP] [\-\-\fBshownoactivate\fP]"
  17 .RB "[\-\-\fBshownormal\fP] [\-\-\fBusage\fP] [\-\-\fBversion\fP]"
  18 .RB "[\-\-\fBlicense\fP] [\-\-\fBreference\fP]"
  19 .RB "\fIfile\fP [\fIarguments\fP]"
  20 .br
  21 .\"}}}
  22 .\"{{{  Description
  23 .SH DESCRIPTION
  24 .B cygstart
  25 is a command-line tool which allows you to let Windows start a program or open
  26 a file or URL in its associated application.  It is similar to the Windows
  27 command-line \fBstart\fP command.
  28 .\"}}}
  29 .\"{{{  Options
  30 .SH OPTIONS
  31
  32 .TP
  33 \fIAction options\fP
  34
  35 .TP
  36 \fB\-a\fP, \fB\-\-action\fP=\fISTRING\fP
  37 Use specified action instead of default
  38
  39 .TP
  40 \fB\-o\fP, \fB\-\-open\fP
  41 Short for: \fB\-\-action\fP \fIopen\fP
  42
  43 .TP
  44 \fB\-x\fP, \fB\-\-explore\fP
  45 Short for: \fB\-\-action\fP \fIexplore\fP
  46
  47 .TP
  48 \fB\-e\fP, \fB\-\-edit\fP
  49 Short for: \fB\-\-action\fP \fIedit\fP
  50
  51 .TP
  52 \fB\-f\fP, \fB\-\-find\fP
  53 Short for: \fB\-\-action\fP \fIfind\fP
  54
  55 .TP
  56 \fB\-p\fP, \fB\-\-print\fP
  57 Short for: \fB\-\-action\fP \fIprint\fP
  58
  59 .TP
  60 \fIDirectory options\fP
  61
  62 .TP
  63 \fB\-d\fP, \fB\-\-directory\fP=\fISTRING\fP
  64 Set working directory
  65
  66 .TP
  67 \fIShow options\fP
  68
  69 .TP
  70 \fB\-\-hide\fP
  71 Hides the window and activates another window
  72
  73 .TP
  74 \fB\-\-maximize\fP
  75 Maximizes the specified window
  76
  77 .TP
  78 \fB\-\-minimize\fP
  79 Minimizes the specified window and activates the
  80 next top-level window in the z-order
  81
  82 .TP
  83 \fB\-\-restore\fP
  84 Activates and displays the window. If the window
  85 is minimized or maximized, Windows restores it to
  86 its original size and position. An application
  87 should specify this flag when restoring a
  88 minimized window
  89
  90 .TP
  91 \fB\-\-show\fP
  92 Activates the window and displays it in its
  93 current size and position
  94
  95 .TP
  96 \fB\-\-showmaximized\fP
  97 Activates the window and displays it as a
  98 maximized window
  99
 100 .TP
 101 \fB\-\-showminimized\fP
 102 Activates the window and displays it as a
 103 minimized window
 104
 105 .TP
 106 \fB\-\-showminnoactive\fP
 107 Displays the window as a minimized window. The
 108 active window remains active
 109
 110 .TP
 111 \fB\-\-showna\fP
 112 Displays the window in its current state. The
 113 active window remains active
 114
 115 .TP
 116 \fB\-\-shownoactivate\fP
 117 Displays a window in its most recent size and
 118 position. The active window remains active
 119
 120 .TP
 121 \fB\-\-shownormal\fP
 122 Activates and displays a window. If the window is
 123 minimized or maximized, Windows restores it to
 124 its original size and position. An application
 125 should specify this flag when displaying the
 126 window for the first time
 127
 128 .TP
 129 \fIHelp options\fP
 130
 131 .TP
 132 \fB\-?\fP, \fB\-\-help\fP
 133 Show this help message
 134
 135 .TP
 136 \fB\-\-usage\fP
 137 Display brief usage message
 138
 139 .TP
 140 \fB\-\-version\fP
 141 Display version information
 142
 143 .TP
 144 \fB\-\-license\fP
 145 Display licensing information
 146
 147 .TP
 148 \fB\-\-reference\fP
 149 Open MSDN reference for ShellExecute
 150
 151 .SH EXAMPLES
 152 Start Bash in a new window
 153 .PP
 154 .nf
 155 \fB$ cygstart bash\fP
 156 .fi
 157 .PP
 158 Open the Cygwin website in your default browser:
 159 .PP
 160 .nf
 161 \fB$ cygstart http://www.cygwin.com\fP
 162 .fi
 163 .PP
 164 Print a text file
 165 .PP
 166 .nf
 167 \fB$ cygstart --print README.txt\fP
 168 .fi
 169 .PP
 170 Open a Word document in a maximized window
 171 .PP
 172 .nf
 173 \fB$ cygstart --maximize ~/projects/whatever/design.doc\fP
 174 .fi
 175
 176 .SH COPYRIGHT
 177 Copyright (C) 2002 Michael Schaap
 178 .PP
 179 \fBcygstart\fP is free software: you can redistribute it and/or modify
 180 it under the terms of the GNU General Public License as published by
 181 the Free Software Foundation, either version 3 of the License, or
 182 (at your option) any later version.
 183 .PP
 184 \fBcygstart\fP is distributed in the hope that it will be useful,
 185 but WITHOUT ANY WARRANTY; without even the implied warranty of
 186 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 187 GNU General Public License for more details.
 188 .PP
 189 You should have received a copy of the GNU General Public License
 190 along with this program.  If not, see
 191 .BR <http://www.gnu.org/licenses/>
 192 .PP
 193 See the COPYING file for full license information.
 194 .\"{{{  Author
 195 .SH AUTHOR
 196 Michael Schaap <cygstart(at)mscha.org>
 197 .\"}}}
 198 .\"{{{  See also
 199 .SH "SEE ALSO"
 200 .BR <http://msdn.microsoft.com/en-us/library/bb762153%28VS.85%29.aspx>
 201 .\"}}}