Changeset 91 for trunk/appswitch/appswitch.1

Timestamp:

02/10/03 20:08:11 (22 years ago)

Author:

Nicholas Riley

Message:

appswitch 1.0b1 code changes

Location:

trunk/appswitch

Files:

• . (modified) (1 prop)
• appswitch.1 (modified) (1 diff)

trunk/appswitch/appswitch.1

@@ -1 @@
-.\"Modified from man(1) of FreeBSD, the NetBSD mdoc.template, and mdoc.samples.
-.\"See Also:
-.\"man mdoc.samples for a complete listing of options
-.\"man mdoc for the short list of editing options
-.\"/usr/share/misc/mdoc.template
-.Dd Tue Feb 04 2003               \" DATE 
-.Dt appswitch 1      \" Program name and manual section number 
-.Os Darwin
-.Sh NAME                 \" Section Header - required - don't modify 
-.Nm appswitch,
-.\" The following lines are read in generating the apropos(man -k) database. Use only key
-.\" words here as the database is built based on the words here and in the .ND line. 
-.Nm Other_name_for_same_program(),
-.Nm Yet another name for the same program.
-.\" Use .Nm macro to designate other names for the documented program.
-.Nd This line parsed for whatis database.
-.Sh SYNOPSIS             \" Section Header - required - don't modify
+.Dd Mon Feb 10 2003               \" DATE 
+.Dt APPSWITCH 1 LOCAL      \" Program name and manual section number 
+.Os appswitch 1.0b1
+.Sh NAME
+.Nm appswitch
+.Nd switch, hide, show, kill or list Mac OS X applications
+.Sh SYNOPSIS
+.Nm appswitch
+.Op Fl sShHkFlP          \" [-sShHkFlP]
+.Op Fl c Ar creator      \" [-c creator]
+.Op Fl i Ar bundleID     \" [-i bundleID]
+.Op Fl a Ar name         \" [-a name]
+.Op Fl p Ar pid          \" [-p pid]
+.Op Ar path              \" [path]
+.Sh DESCRIPTION
 .Nm
-.Op Fl abcd              \" [-abcd]
-.Op Fl a Ar path         \" [-a path] 
-.Op Ar file              \" [file]
-.Op Ar                   \" [file ...]
-.Ar arg0                 \" Underlined argument - use .Ar anywhere to underline
-arg2 ...                 \" Arguments
-.Sh DESCRIPTION          \" Section Header - required - don't modify
-Use the .Nm macro to refer to your program throughout the man page like such:
+controls the ordering and visibility of Mac OS X application windows.
 .Nm
-Underlining is accomplished with the .Ar macro like this:
-.Ar underlined text .
-.Pp                      \" Inserts a space
-A list of items with descriptions:
-.Bl -tag -width -indent  \" Begins a tagged list 
-.It item a               \" Each item preceded by .It macro
-Description of item a
-.It item b
-Description of item b
-.El                      \" Ends the list
-.Pp
-A list of flags and their descriptions:
-.Bl -tag -width -indent  \" Differs from above in tag removed 
-.It Fl a                 \"-a flag as a list item
-Description of -a flag
-.It Fl b
-Description of -b flag
-.El                      \" Ends the list
-.Pp
-.\" .Sh ENVIRONMENT      \" May not be needed
-.\" .Bl -tag -width "ENV_VAR_1" -indent \" ENV_VAR_1 is width of the string ENV_VAR_1
-.\" .It Ev ENV_VAR_1
-.\" Description of ENV_VAR_1
-.\" .It Ev ENV_VAR_2
-.\" Description of ENV_VAR_2
-.\" .El                      
-.Sh FILES                \" File used or created by the topic of the man page
-.Bl -tag -width "/Users/joeuser/Library/really_long_file_name" -compact
-.It Pa /usr/share/file_name
-FILE_1description
-.It Pa /Users/joeuser/Library/really_long_file_name
-FILE_2 description
-.\" .Sh DIAGNOSTICS       \" May not be needed
-.\" .Bl -diag
-.\" .It Diagnostic Tag
-.\" Diagnostic informtion here.
-.\" .It Diagnostic Tag
-.\" Diagnostic informtion here.
-.\" .El
+can also list or kill running applications.
+.Ss Matching options
+Matching identifies one or more applications to manipulate.
+.Bl -tag -width -indent
+.It Fl c Ar creator
+Match by creator (a four-character code, also known as a signature).
+.It Fl i Ar bundle ID
+Match by bundle identifier, usually consisting of the reversed dot
+(.)-separated components of the application developer's Internet domain
+name, followed by the application name.  For example, the Finder's
+bundle identifier is
+.Ar com.apple.Finder .
+Bundle identifiers are not case-sensitive.
+.It Fl p Ar pid
+Match by process identifier, a positive number.
+.It Ar path
+Match by bundle path.  For packaged applications, this is the package
+directory whose name typically has the .app extension, for example
+.Ar /Applications/TextEdit.app
+for the default installation location of TextEdit.  For non-packaged
+applications, this is the path to the executable itself.
+.El
+.Ss Application actions
+These actions apply to the matched application. If multiple
+applications match the supplied criteria, only the first matching
+application is acted upon.  The list option
+.Fl l
+displays all matching applications.
+.Bl -tag -width -indent
+.It Fl s
+Show the application, making the application's windows frontmost. Do
+not switch to the application.
+.It Fl h
+Hide the application's windows.
+.It Fl k
+Kill (force quit) the application.
+.It Fl l
+List applications in a format similar to that of
+.Xr ps 1 . The columns of the listing are as follows:
+.Bl -tag -width indent
+.It PSN
+The process serial number of the application.  Process serial numbers
+are unique identifiers among both native Mac OS X and Classic
+applications.
+.It PID
+The process identifier, a positive number which uniquely identifies
+native Mac OS X processes, usable with the
+.Fl p
+matching option.  Because all Classic applications run inside
+TruBlueEnvironment, a single Mac OS X process, their process
+identifiers appear as -1.
+.It TYPE
+The four-character code identifying the application's type,
+usually 'APPL' for most applications or 'FNDR' for the Finder.
+Classic applications include additional types such as 'appe'
+and 'APPC' for applications which perform the functions of extensions
+and control panels, respectively.
+.It CREA
+The four-character code identifying the application's creator, usable with the
+.Fl c
+matching option. Some Mac OS X applications have no creator, appearing
+as '????'; for these applications you must use the bundle identifier,
+name or path as match criteria.
+.It NAME
+The user-visible application name, usable with the
+.Fl a
+matching option. This field is truncated to 20 characters; the
+remainder of longer application names is not displayed.
+.It PATH
+The path to the application bundle, usable with the
+.Ar path
+matching option. This field is truncated to the window width, or to 80
+characters if the window width cannot be determined.
+.El
+.It Fl p
+Print the application's process identifier (PID), a positive number
+and unique identifier for all applications except Classic
+applications.
+.El
+.Ss Actions
+These actions affect all applications currently running.
+.Bl -tag -width -indent
+.It Fl S
+Show all applications, layering the windows of initially hidden
+applications on top.
+.It Fl H
+Hide windows of all applications other than the matched application,
+or the frontmost application if no application has been matched.
+.It Fl F
+Order the current application's windows to the front.
+.El
 .Sh SEE ALSO 
 .\" List links in ascending order by section, alphabetically within a section.
 .\" Please do not reference files that do not exist without filing a bug report
-.Xr a 1 , 
-.Xr b 1 ,
-.Xr c 1 ,
-.Xr a 2 ,
-.Xr b 2 ,
-.Xr a 3 ,
-.Xr b 3 
-.\" .Sh BUGS              \" Document known, unremedied bugs 
+.Xr open 1 ,
+.Xr launch 1 ,
+.Xr ps 1 ,
+.Xr kill 1 ,
+.Xr GetFileInfo 1
+.Sh BUGS              \" Document known, unremedied bugs
+The
+.Fl F
+option may be unreliable if issued immediately after another show or
+hide command; try inserting a
+.Xr sleep 1
+command before it.
+.Sh AUTHORS
+.An "Nicholas Riley" Aq appswitch@sabi.net
 .\" .Sh HISTORY           \" Document history if command behaves in a unique manner