annotate buf_erase.3 @ 23:b7690784cd17 0.3.0

misc: update before 0.3.0
author David Demelier <markand@malikania.fr>
date Thu, 16 Sep 2021 13:56:31 +0200
parents d87e84936795
children dbdc17e11648
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 .\" buf_erase.3 -- simple string buffer for C
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 .\"
22
d87e84936795 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
4 .\" Copyright (c) 2019-2021 David Demelier <markand@malikania.fr>
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 .\" Permission to use, copy, modify, and/or distribute this software for any
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 .\" purpose with or without fee is hereby granted, provided that the above
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 .\" copyright notice and this permission notice appear in all copies.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 .\"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 .\"
22
d87e84936795 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
18 .Dd October 29, 2019-2021
0
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 .Dt BUF_ERASE 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 .Os
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 .\" NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 .Sh NAME
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 .Nm buf_erase
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
24 .Nd erase a portion of the string
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 .\" SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 .Sh SYNOPSIS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 .In buf.h
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 .Ft void
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 .Fn buf_erase "struct buf *b" "size_t pos" "size_t count"
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
30 .\" DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 .Sh DESCRIPTION
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 Remove
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 .Fa count
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 number of character in the buffer specified by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 .Fa b
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 starting at
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 .Fa pos .
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
38 .Pp
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 It is possible to pass -1 as
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 .Fa count
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
41 parameter to remove the remaining text until the end of the string.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 .Pp
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 Undefined behavior may occur if the
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
44 .Fa pos
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 argument is outside of the buffer bounds.
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 .\" SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
47 .Sh SEE ALSO
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 .Xr libbuf 3
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 .\" AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
50 .Sh AUTHORS
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 The
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
52 .Nm libbuf
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
53 library was written by
b1991ee4451d misc: initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
54 .An David Demelier <markand@malikania.fr>