Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 46 lines (26 sloc) 0.903 kB
8a5c6de @mauke add some docs
authored
1 =pod
2
3 =head1 NAME
4
5 unibi_dump - convert a terminal object to compiled terminfo data
6
7 =head1 SYNOPSIS
8
0e394fd @mauke change to <unibilium.h> in the documentation
authored
9 #include <unibilium.h>
8a5c6de @mauke add some docs
authored
10
11 size_t unibi_dump(const unibi_term *ut, char *p, size_t n);
12
13 =head1 DESCRIPTION
14
15 This function creates a compiled terminfo entry from I<ut>. The output is
16 written to I<p>, which must have room for at least I<n> bytes.
17
18 =head1 RETURN VALUE
19
20 C<unibi_dump> returns the number of bytes required to store the terminfo data.
21 If this exceeds I<n>, nothing is written to I<p>. If the terminal object can't
29bc09d @mauke documentation for extended capability stuff
authored
22 be represented in terminfo format (e.g. because the string table would be too
23 large), the return value is C<SIZE_MAX>.
8a5c6de @mauke add some docs
authored
24
25 =head1 ERRORS
26
27 =over
28
29 =item C<EINVAL>
30
31 I<ut> can't be converted to terminfo format.
32
33 =item C<EFAULT>
34
35 The resulting terminfo entry would be longer than I<n> bytes.
36
37 =back
38
39 =head1 SEE ALSO
40
41 L<unibilium.h(3)>,
42 L<unibi_destroy(3)>,
43 L<unibi_from_mem(3)>
44
45 =cut
Something went wrong with that request. Please try again.