fcab7d1011abcecb8efedd3536f8362ca2fe0803
[dragonfly.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 .\" $DragonFly: src/usr.bin/uac/Attic/uac.1,v 1.2 2003/06/17 04:29:33 dillon Exp $
27 .\"
28 .Dd January 18, 2000
29 .Dt UAC 1
30 .Os
31 .Sh NAME
32 .Nm uac
33 .Nd Unaligned Access Message Control
34 .Sh SYNOPSIS
35 .Nm
36 .Op Fl fprs
37 .Sh DESCRIPTION
38 The
39 .Nm
40 utility sets the per-process handling of
41 .Dq Unaligned Access
42 events.
43 Unlike many other CPU's the DEC Alpha processor cannot access unaligned data.
44 To work around this, the Alpha has the ability to fix the UA fault
45 rather than send the faulting process a
46 .Dv SIGBUS
47 signal.
48 However, doing so does slow down the
49 execution of the faulting process.
50 At bootup, the DEC Alpha CPU defaults to printing
51 .Bd -ragged
52 .Em pid
53 .Ar nnn Pq Ar <progname> :
54 unaligned access:
55 .Em va Ns = Ns Ar 0xADDR
56 .Em pc Ns = Ns Ar 0xADDR
57 .Em ra Ns = Ns Ar 0xADDR
58 .Em op Ns = Ns Ar ldl
59 .Ed
60 .Pp
61 when a UA happens along with fixing it,
62 so the faulting instruction can continue.
63 UA handling settings are inherited by child process.
64 Issued without any options,
65 .Nm
66 displays the current UA handling for the parent process.
67 .Pp
68 The options are as follows:
69 .Bl -tag -width Fl
70 .It Fl f
71 Unaligned access errors are not fixed for the parent and its future descendants.
72 .It Fl p
73 Unaligned access errors are not printed for the parent and its future
74 descendants.
75 .It Fl r
76 Resets the unaligned access error settings back to their bootup defaults.
77 .It Fl s
78 Unaligned access errors result in a
79 .Dv SIGBUS
80 being delivered to the parent and its future descendants.
81 This aids in pinpointing the faulting access so it can be debugged.
82 .El
83 .Sh DIAGNOSTICS
84 Exit status is 0 on success, and 1 if the command
85 fails for any reason.
86 .Sh COMPATIBILITY
87 The
88 .Nm
89 command syntax is incompatible with the DEC OSF/1 syntax.
90 .Sh SEE ALSO
91 .Xr signal 3
92 .Sh HISTORY
93 A
94 .Nm
95 utility first appeared in DEC OSF/1.
96 .Sh AUTHORS
97 .An -nosplit
98 The
99 .Fx
100 version of
101 .Nm
102 was originally written by
103 .An Andrew Gallatin Aq gallatin@cs.duke.edu
104 and modified by
105 .An David E. O'Brien Aq obrien@FreeBSD.org .
106 This
107 manual page was written by
108 .An David E. O'Brien Aq obrien@FreeBSD.org .