source: trunk/appswitch/appswitch/appswitch.1 @ 96

Last change on this file since 96 was 96, checked in by Nicholas Riley, 17 years ago

man page cleanup

File size: 4.8 KB
Line 
1.Dd Mon Feb 10 2003               \" DATE
2.Dt APPSWITCH 1 LOCAL      \" Program name and manual section number
3.Os appswitch 1.0b1
4.Sh NAME
5.Nm appswitch
6.Nd switch, hide, show, kill or list Mac OS X applications
7.Sh SYNOPSIS
8.Nm appswitch
9.Op Fl sShHkFlP          \" [-sShHkFlP]
10.Op Fl c Ar creator      \" [-c creator]
11.Op Fl i Ar bundleID     \" [-i bundleID]
12.Op Fl a Ar name         \" [-a name]
13.Op Fl p Ar pid          \" [-p pid]
14.Op Ar path              \" [path]
15.Sh DESCRIPTION
16.Nm
17controls the ordering and visibility of Mac OS X application windows.
18.Nm
19can also list or kill running applications.
20.Ss Matching options
21Matching identifies one or more applications to manipulate.
22.Bl -tag -width -indent
23.It Fl c Ar creator
24Match by creator (a four-character code, also known as a signature).
25.It Fl i Ar bundle ID
26Match by bundle identifier, usually consisting of the reversed dot
27(.)-separated components of the application developer's Internet domain
28name, followed by the application name.  For example, the Finder's
29bundle identifier is
30.Ar com.apple.Finder .
31Bundle identifiers are not case-sensitive.
32.Pp
33If you're extremely concerned about the speed of matching, any other
34match method is faster than a match by bundle identifier.
35.It Fl p Ar pid
36Match by process identifier, a positive number.
37.It Ar path
38Match by bundle path.  For packaged applications, this is the package
39directory whose name typically has the .app extension, for example
40.Ar /Applications/TextEdit.app
41for the default installation location of TextEdit.  For non-packaged
42applications, this is the path to the executable itself.
43.El
44.Ss Application actions
45These actions apply to the matched application. If multiple
46applications match the supplied criteria, only the first matching
47application is acted upon.  The list option
48.Fl l
49displays all matching applications.
50.Bl -tag -width -indent
51.It Fl s
52Show the application, making the application's windows frontmost. Do
53not switch to the application.
54.It Fl h
55Hide the application's windows.
56.It Fl k
57Kill (force quit) the application.
58.It Fl l
59List applications in a format similar to that of
60.Xr ps 1 . The columns of the listing are as follows:
61.Bl -tag -width indent
62.It PSN
63The process serial number of the application.  Process serial numbers
64are unique identifiers among both native Mac OS X and Classic
65applications.
66.It PID
67The process identifier, a positive number which uniquely identifies
68native Mac OS X processes, usable with the
69.Fl p
70matching option.  Because all Classic applications run inside
71TruBlueEnvironment, a single Mac OS X process, their process
72identifiers appear as -1.
73.It TYPE
74The four-character code identifying the application's type,
75usually
76.Ql APPL
77for most applications or
78.Ql FNDR
79for the Finder.
80Classic applications include additional types such as
81.Ql appe
82and
83.Ql APPC
84for applications which perform the functions of extensions
85and control panels, respectively.
86.It CREA
87The four-character code identifying the application's creator, usable with the
88.Fl c
89matching option. Some Mac OS X applications have no creator, appearing
90as
91.Ql ???? ;
92for these applications you must use the bundle identifier,
93name or path as match criteria.
94.It NAME
95The user-visible application name, usable with the
96.Fl a
97matching option. This field is truncated to 20 characters; the
98remainder of longer application names is not displayed.
99.It PATH
100The path to the application bundle, usable with the
101.Ar path
102matching option. This field is truncated to the window width, or to 80
103characters if the window width cannot be determined.
104.El
105.It Fl P
106Print the application's process identifier (PID), a positive number
107and unique identifier for all applications except Classic
108applications.
109.El
110.Ss Actions
111These actions affect all applications currently running.
112.Bl -tag -width -indent
113.It Fl S
114Show all applications, layering the windows of initially hidden
115applications on top.
116.It Fl H
117Hide windows of all applications other than the matched application,
118or the frontmost application if no application has been matched.
119.It Fl F
120Order the current application's windows to the front.
121.El
122.Sh SEE ALSO
123.\" List links in ascending order by section, alphabetically within a section.
124.\" Please do not reference files that do not exist without filing a bug report
125.Xr open 1 ,
126.Xr launch 1 ,
127.Xr ps 1 ,
128.Xr kill 1 ,
129.Xr GetFileInfo 1
130.Sh BUGS              \" Document known, unremedied bugs
131The
132.Fl F
133option may be unreliable if issued immediately after another show or
134hide command; try inserting a
135.Xr sleep 1
136command before it.
137.Sh AUTHORS
138.An "Nicholas Riley" Aq appswitch@sabi.net
139.\" .Sh HISTORY           \" Document history if command behaves in a unique manner
140
Note: See TracBrowser for help on using the repository browser.