Fold in latest clip fixes

[cygwin-apps/cygutils.git] / src / cygstart / cygstart.1

.\"{{{}}}
.\"{{{  Title
.TH CYGSTART 1 "14 Mar 2002" "cygstart 1.0 (cygutils)" "Cygutils"
.\"}}}
.\"{{{  Name
.SH NAME
cygstart \- start a program or open a file or URL
.\"}}}
.\"{{{  Synopsis
.SH SYNOPSIS
.B cygstart
.RB "[\-\fBoxefp?\fP] [\-\fBa\fP \fIaction\fP] [\-\fBd\fP \fIdirectory\fP]"
.RB "[\-\-\fBhide\fP] [\-\-\fBmaximize\fP] [\-\-\fBminimize\fP]"
.RB "[\-\-\fBrestore\fP] [\-\-\fBshow\fP] [\-\-\fBshowmaximized\fP]"
.RB "[\-\-\fBshowminimized\fP] [\-\-\fBshowminnoactive\fP]"
.RB "[\-\-\fBshowna\fP] [\-\-\fBshownoactivate\fP]"
.RB "[\-\-\fBshownormal\fP] [\-\-\fBusage\fP] [\-\-\fBversion\fP]"
.RB "[\-\-\fBlicense\fP] [\-\-\fBreference\fP]"
.RB "\fIfile\fP [\fIarguments\fP]"
.br
.\"}}}
.\"{{{  Description
.SH DESCRIPTION
.B cygstart
is a command-line tool which allows you to let Windows start a program or open
a file or URL in its associated application.  It is similar to the Windows
command-line \fBstart\fP command.
.\"}}}
.\"{{{  Options
.SH OPTIONS

.TP
\fIAction options\fP

.TP
\fB\-a\fP, \fB\-\-action\fP=\fISTRING\fP
Use specified action instead of default

.TP
\fB\-o\fP, \fB\-\-open\fP
Short for: \fB\-\-action\fP \fIopen\fP

.TP
\fB\-x\fP, \fB\-\-explore\fP
Short for: \fB\-\-action\fP \fIexplore\fP

.TP
\fB\-e\fP, \fB\-\-edit\fP
Short for: \fB\-\-action\fP \fIedit\fP

.TP
\fB\-f\fP, \fB\-\-find\fP
Short for: \fB\-\-action\fP \fIfind\fP

.TP
\fB\-p\fP, \fB\-\-print\fP
Short for: \fB\-\-action\fP \fIprint\fP

.TP
\fIDirectory options\fP

.TP
\fB\-d\fP, \fB\-\-directory\fP=\fISTRING\fP
Set working directory

.TP
\fIShow options\fP

.TP
\fB\-\-hide\fP
Hides the window and activates another window

.TP
\fB\-\-maximize\fP
Maximizes the specified window

.TP
\fB\-\-minimize\fP
Minimizes the specified window and activates the
next top-level window in the z-order

.TP
\fB\-\-restore\fP
Activates and displays the window. If the window
is minimized or maximized, Windows restores it to
its original size and position. An application
should specify this flag when restoring a
minimized window

.TP
\fB\-\-show\fP
Activates the window and displays it in its
current size and position

.TP
\fB\-\-showmaximized\fP
Activates the window and displays it as a
maximized window

.TP
\fB\-\-showminimized\fP
Activates the window and displays it as a
minimized window

.TP
\fB\-\-showminnoactive\fP
Displays the window as a minimized window. The
active window remains active

.TP
\fB\-\-showna\fP
Displays the window in its current state. The
active window remains active

.TP
\fB\-\-shownoactivate\fP
Displays a window in its most recent size and
position. The active window remains active

.TP
\fB\-\-shownormal\fP
Activates and displays a window. If the window is
minimized or maximized, Windows restores it to
its original size and position. An application
should specify this flag when displaying the
window for the first time

.TP
\fIHelp options\fP

.TP
\fB\-?\fP, \fB\-\-help\fP
Show this help message

.TP
\fB\-\-usage\fP
Display brief usage message

.TP
\fB\-\-version\fP
Display version information

.TP
\fB\-\-license\fP
Display licensing information

.TP
\fB\-\-reference\fP
Open MSDN reference for ShellExecute

.SH EXAMPLES
Start Bash in a new window
.PP
.nf
\fB$ cygstart bash\fP
.fi
.PP
Open the Cygwin website in your default browser:
.PP
.nf
\fB$ cygstart http://www.cygwin.com\fP
.fi
.PP
Print a text file
.PP
.nf
\fB$ cygstart --print README.txt\fP
.fi
.PP
Open a Word document in a maximized window
.PP
.nf
\fB$ cygstart --maximize ~/projects/whatever/design.doc\fP
.fi

.SH COPYRIGHT
Copyright (C) 2002 Michael Schaap
.PP
\fBcygstart\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 3 of the License, or
(at your option) any later version.
.PP
\fBcygstart\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
along with this program.  If not, see
.BR <http://www.gnu.org/licenses/>
.PP
See the COPYING file for full license information.
.\"{{{  Author
.SH AUTHOR
Michael Schaap <cygstart(at)mscha.org>
.\"}}}
.\"{{{  See also
.SH "SEE ALSO"
.BR <http://msdn.microsoft.com/en-us/library/bb762153%28VS.85%29.aspx>
.\"}}}