Sync usage with man page.
[netbsd-mini2440.git] / share / man / man9 / setjmp.9
blobbdfede55028d9d03d3e9e684f0ad559035aa5c6a
1 .\"     $NetBSD: setjmp.9,v 1.3 2003/04/16 13:35:33 wiz Exp $
2 .\"
3 .\" Copyright (c) 2002 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" This code is derived from software contributed to The NetBSD Foundation
7 .\" by Gregory McGarry.
8 .\"
9 .\" Redistribution and use in source and binary forms, with or without
10 .\" modification, are permitted provided that the following conditions
11 .\" are met:
12 .\" 1. Redistributions of source code must retain the above copyright
13 .\"    notice, this list of conditions and the following disclaimer.
14 .\" 2. Redistributions in binary form must reproduce the above copyright
15 .\"    notice, this list of conditions and the following disclaimer in the
16 .\"    documentation and/or other materials provided with the distribution.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 .\" POSSIBILITY OF SUCH DAMAGE.
29 .\"
30 .Dd May 23, 2002
31 .Dt SETJMP 9
32 .Os
33 .Sh NAME
34 .Nm setjmp ,
35 .Nm longjmp
36 .Nd non-local jumps
37 .Sh SYNOPSIS
38 .In machine/types.h
39 .In sys/systm.h
40 .Ft int
41 .Fn setjmp "label_t *label"
42 .Ft void
43 .Fn longjmp "label_t *label"
44 .Sh DESCRIPTION
45 The
46 .Fn setjmp
47 function saves its calling environment in
48 .Fa label .
49 It returns zero on success.
50 The
51 .Fn longjmp
52 function restores the environment saved by the most recent
53 invocation of
54 .Fn setjmp .
55 It returns so that kernel execution continues as if
56 the corresponding invocation of the
57 .Fn setjmp
58 had just returned.
59 .Pp
60 .Fn setjmp
61 and
62 .Fn longjmp
63 are a machine-independent interface for machine-dependent
64 implementations.
65 .Pp
66 These functions are primarily used by
67 .Xr ddb 4 .
68 .Sh SEE ALSO
69 .Xr ddb 4