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

Last change on this file since 295 was 160, checked in by Nicholas Riley, 16 years ago

package-appswitch.sh: replace pbxbuild with xcodebuild; fix permissions

appswitch/appswitch.1: updated for actual release date

appswitch/main.c: updated for 1.0.1; fix PSN width, resolves #1; fix
compiler warning

appswitch/README: updated for actual release date; PB -> Xcode;
updated timings; updated version history

File size: 5.5 KB
Line 
1.Dd Sun May 16 2004      \" DATE
2.Dt APPSWITCH 1 LOCAL    \" Program name and manual section number
3.Os appswitch 1.0.1
4.Sh NAME
5.Nm appswitch
6.Nd switch, hide, show, quit, kill or list Mac OS X applications
7.Sh SYNOPSIS
8.Nm appswitch
9.Op Fl sShHqkKFlLP       \" [-sShHqkKFlLP]
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 integer.
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 q
57Quit the application.
58.It Fl k
59Kill (force quit) the application.  Sends the
60.Dv SIGINT
61signal to the application, which the application may
62ignore.  Equivalent to selecting
63.Dq Force Quit
64from an application's menu in the Dock for the first time.
65.It Fl K
66Kill (force quit) the application.  Sends the
67.Dv SIGKILL
68signal to the application, which the application may not ignore.
69Equivalent to selecting
70.Dq Force Quit
71from an application's menu in the Dock for the second time.
72.It Fl l
73List applications in a format similar to that of
74.Xr ps 1 .
75The columns of the listing are as follows:
76.Bl -tag -width indent
77.It PSN
78The process serial number of the application.  Process serial numbers
79are unique identifiers among both native Mac OS X and Classic
80applications.
81.It PID
82The process identifier, a positive integer which uniquely identifies
83native Mac OS X processes, usable with the
84.Fl p
85matching option.  Because all Classic applications run inside
86TruBlueEnvironment, a single Mac OS X process, their process
87identifiers appear as -1.
88.It TYPE
89The four-character code identifying the application's type,
90usually
91.Ql APPL
92for most applications or
93.Ql FNDR
94for the Finder.
95Classic applications include additional types such as
96.Ql appe
97and
98.Ql APPC
99for applications which perform the functions of extensions
100and control panels, respectively.
101.It CREA
102The four-character code identifying the application's creator, usable with the
103.Fl c
104matching option. Some Mac OS X applications have no creator, appearing
105as
106.Ql ???? ;
107for these applications you must use the bundle identifier,
108name or path as match criteria.
109.It NAME
110The user-visible application name, usable with the
111.Fl a
112matching option. This field is truncated to 20 characters; the
113remainder of longer application names is not displayed.
114.It PATH
115The path to the application bundle, usable with the
116.Ar path
117matching option. This field is truncated to the window width, or to 80
118characters if the window width cannot be determined.
119.El
120.It Fl L
121List applications in a format similar to that of
122.Xr ps 1 .
123The columns of the listing are as above, but the path field is not
124truncated to the window width, and a bundle identifier is added in
125parentheses after the path, usable with the
126.Fl i
127matching option.
128.It Fl P
129Print the application's process identifier (PID), a positive integer
130and unique identifier for all applications except Classic
131applications.
132.El
133.Ss Actions
134These actions affect all applications currently running.
135.Bl -tag -width -indent
136.It Fl S
137Show all applications, layering the windows of initially hidden
138applications on top.
139.It Fl H
140Hide windows of all applications other than the matched application,
141or the frontmost application if no application has been matched.
142.It Fl F
143Order the current application's windows to the front.
144.El
145.Sh SEE ALSO
146.\" List links in ascending order by section, alphabetically within a section.
147.\" Please do not reference files that do not exist without filing a bug report
148.Xr open 1 ,
149.Xr launch 1 ,
150.Xr ps 1 ,
151.Xr kill 1 ,
152.Xr GetFileInfo 1
153.Sh BUGS              \" Document known, unremedied bugs
154The
155.Fl F
156option may be unreliable if issued immediately after another show or
157hide command; try inserting a
158.Xr sleep 1
159command before it.
160.Pp
161The
162.Fl q
163option is very slow on Mac OS X 10.2.8 and earlier; this is an
164acknowledged bug in AECreateAppleEvent with no known workaround.
165The bug is fixed in Mac OS X 10.3.
166.Sh AUTHOR
167.An "Nicholas Riley" Aq appswitch@sabi.net
168.\" .Sh HISTORY           \" Document history if command behaves in a unique manner
Note: See TracBrowser for help on using the repository browser.