Initial import from FreeBSD RELENG_4:
[games.git] / usr.bin / uac / uac.1
1 .\" Copyright (c) 2000 David E. O'Brien
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23 .\" SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/usr.bin/uac/uac.1,v 1.3.2.7 2002/06/21 15:29:49 charnier Exp $
26 .\"
27 .Dd January 18, 2000
28 .Dt UAC 1
29 .Os
30 .Sh NAME
31 .Nm uac
32 .Nd Unaligned Access Message Control
33 .Sh SYNOPSIS
34 .Nm
35 .Op Fl fprs
36 .Sh DESCRIPTION
37 The
38 .Nm
39 utility sets the per-process handling of
40 .Dq Unaligned Access
41 events.
42 Unlike many other CPU's the DEC Alpha processor cannot access unaligned data.
43 To work around this, the Alpha has the ability to fix the UA fault
44 rather than send the faulting process a
45 .Dv SIGBUS
46 signal.
47 However, doing so does slow down the
48 execution of the faulting process.
49 At bootup, the DEC Alpha CPU defaults to printing
50 .Bd -ragged
51 .Em pid
52 .Ar nnn Pq Ar <progname> :
53 unaligned access:
54 .Em va Ns = Ns Ar 0xADDR
55 .Em pc Ns = Ns Ar 0xADDR
56 .Em ra Ns = Ns Ar 0xADDR
57 .Em op Ns = Ns Ar ldl
58 .Ed
59 .Pp
60 when a UA happens along with fixing it,
61 so the faulting instruction can continue.
62 UA handling settings are inherited by child process.
63 Issued without any options,
64 .Nm
65 displays the current UA handling for the parent process.
66 .Pp
67 The options are as follows:
68 .Bl -tag -width Fl
69 .It Fl f
70 Unaligned access errors are not fixed for the parent and its future descendants.
71 .It Fl p
72 Unaligned access errors are not printed for the parent and its future
73 descendants.
74 .It Fl r
75 Resets the unaligned access error settings back to their bootup defaults.
76 .It Fl s
77 Unaligned access errors result in a
78 .Dv SIGBUS
79 being delivered to the parent and its future descendants.
80 This aids in pinpointing the faulting access so it can be debugged.
81 .El
82 .Sh DIAGNOSTICS
83 Exit status is 0 on success, and 1 if the command
84 fails for any reason.
85 .Sh COMPATIBILITY
86 The
87 .Nm
88 command syntax is incompatible with the DEC OSF/1 syntax.
89 .Sh SEE ALSO
90 .Xr signal 3
91 .Sh HISTORY
92 A
93 .Nm
94 utility first appeared in DEC OSF/1.
95 .Sh AUTHORS
96 .An -nosplit
97 The
98 .Fx
99 version of
100 .Nm
101 was originally written by
102 .An Andrew Gallatin Aq gallatin@cs.duke.edu
103 and modified by
104 .An David E. O'Brien Aq obrien@FreeBSD.org .
105 This
106 manual page was written by
107 .An David E. O'Brien Aq obrien@FreeBSD.org .