summaryrefslogtreecommitdiff
path: root/doc/unw_init_local.man
diff options
context:
space:
mode:
authormostang.com!davidm <mostang.com!davidm>2003-03-11 01:05:47 +0000
committermostang.com!davidm <mostang.com!davidm>2003-03-11 01:05:47 +0000
commitcc297605d422c8cc5672d596ea4af151dbdee3c5 (patch)
treede9977004469a40f97f4876e8f2254278d810c43 /doc/unw_init_local.man
parenta494d61a8688b9660eb95f97bfb1807598a46626 (diff)
downloadlibunwind-cc297605d422c8cc5672d596ea4af151dbdee3c5.tar.gz
Initial revision
Diffstat (limited to 'doc/unw_init_local.man')
-rw-r--r--doc/unw_init_local.man124
1 files changed, 0 insertions, 124 deletions
diff --git a/doc/unw_init_local.man b/doc/unw_init_local.man
index a1abca37..e69de29b 100644
--- a/doc/unw_init_local.man
+++ b/doc/unw_init_local.man
@@ -1,124 +0,0 @@
-'\" t
-.\" Manual page created with latex2man on Fri Mar 7 14:50:51 PST 2003
-.\" NOTE: This file is generated, DO NOT EDIT.
-.de Vb
-.ft CW
-.nf
-..
-.de Ve
-.ft R
-
-.fi
-..
-.TH "UNW\\_INIT\\_LOCAL" "3" "07 March 2003" "Programming Library " "Programming Library "
-.SH NAME
-
-.PP
-unw_init_local \-\- initialize cursor for local unwinding
-.PP
-.SH SYNOPSIS
-
-.PP
-#include <libunwind.h>
-.br
-.PP
-int
-unw_init_local(unw_cursor_t *c,
-unw_context_t *ctxt);
-.br
-.PP
-.SH DESCRIPTION
-
-.PP
-The unw_init_local()
-routine initializes the unwind cursor
-pointed to by c
-with the machine\-state in the context structure
-pointed to by ctxt\&.
-As such, the machine\-state pointed to by
-ctxt
-identifies the initial stack frame at which unwinding
-starts. The machine\-state must remain valid for the duration for
-which the cursor c
-is in use.
-.PP
-The unw_init_local()
-routine can be used only for unwinding in
-the address space of the current process (i.e., for local unwinding).
-For all other cases, unw_init_remote()
-must be used instead.
-From a behavioral point of view, the call:
-.PP
-.Vb
- ret = unw_init_local(&cursor, &ucontext);
-.Ve
-is equivalent to:
-.PP
-.Vb
- ret = unw_init_remote(&cursor, unw_local_addr_space,
- &ucontext);
-.Ve
-However, unwind performance may be better when using
-unw_init_local().
-Also, unw_init_local()
-is
-available even when UNW_LOCAL_ONLY
-has been defined before
-including <libunwind.h>,
-whereas unw_init_remote()
-is not.
-.PP
-.SH RETURN VALUE
-
-.PP
-On successful completion, unw_init_local()
-returns 0.
-Otherwise the negative value of one of the error\-codes below is
-returned.
-.PP
-.SH THREAD AND SIGNAL SAFETY
-
-.PP
-unw_init_local()
-is thread\-safe as well as safe to use from a
-signal handler.
-.PP
-.SH ERRORS
-
-.PP
-.TP
-UNW_EINVAL
- unw_init_local()
-was called in a
-version of libunwind
-which supports remote unwinding only
-(this normally happens when calling unw_init_local()
-for a
-cross\-platform version of libunwind).
-.TP
-UNW_EUNSPEC
- An unspecified error occurred.
-.TP
-UNW_EBADREG
- A register needed by unw_init_local()
-wasn\&'t accessible.
-.PP
-.SH SEE ALSO
-
-.PP
-libunwind(3),
-unw_init_remote(3)
-.PP
-.SH AUTHOR
-
-.PP
-David Mosberger\-Tang
-.br
-Hewlett\-Packard Labs
-.br
-Palo\-Alto, CA 94304
-.br
-Email: \fBdavidm@hpl.hp.com\fP
-.br
-WWW: \fBhttp://www.hpl.hp.com/research/linux/libunwind/\fP\&.
-.\" NOTE: This file is generated, DO NOT EDIT.