diff options
Diffstat (limited to 'src/lib/libc/string/string.3')
-rw-r--r-- | src/lib/libc/string/string.3 | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/src/lib/libc/string/string.3 b/src/lib/libc/string/string.3 new file mode 100644 index 0000000000..e29aa6c02c --- /dev/null +++ b/src/lib/libc/string/string.3 | |||
@@ -0,0 +1,157 @@ | |||
1 | .\" Copyright (c) 1990, 1991 The Regents of the University of California. | ||
2 | .\" All rights reserved. | ||
3 | .\" | ||
4 | .\" This code is derived from software contributed to Berkeley by | ||
5 | .\" Chris Torek. | ||
6 | .\" Redistribution and use in source and binary forms, with or without | ||
7 | .\" modification, are permitted provided that the following conditions | ||
8 | .\" are met: | ||
9 | .\" 1. Redistributions of source code must retain the above copyright | ||
10 | .\" notice, this list of conditions and the following disclaimer. | ||
11 | .\" 2. Redistributions in binary form must reproduce the above copyright | ||
12 | .\" notice, this list of conditions and the following disclaimer in the | ||
13 | .\" documentation and/or other materials provided with the distribution. | ||
14 | .\" 3. Neither the name of the University nor the names of its contributors | ||
15 | .\" may be used to endorse or promote products derived from this software | ||
16 | .\" without specific prior written permission. | ||
17 | .\" | ||
18 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND | ||
19 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||
20 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||
21 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | ||
22 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||
23 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||
24 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||
25 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||
26 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||
27 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||
28 | .\" SUCH DAMAGE. | ||
29 | .\" | ||
30 | .\" $OpenBSD: string.3,v 1.9 2003/06/02 20:18:38 millert Exp $ | ||
31 | .\" | ||
32 | .Dd April 19, 1991 | ||
33 | .Dt STRING 3 | ||
34 | .Os | ||
35 | .Sh NAME | ||
36 | .Nm strcat , | ||
37 | .Nm strlcat , | ||
38 | .Nm strncat , | ||
39 | .Nm strchr , | ||
40 | .Nm strrchr , | ||
41 | .Nm strcmp , | ||
42 | .Nm strncmp , | ||
43 | .Nm strcasecmp , | ||
44 | .Nm strncasecmp , | ||
45 | .Nm strcpy , | ||
46 | .Nm strlcpy , | ||
47 | .Nm strncpy , | ||
48 | .Nm strerror , | ||
49 | .Nm strlen , | ||
50 | .Nm strpbrk , | ||
51 | .Nm strsep , | ||
52 | .Nm strspn , | ||
53 | .Nm strcspn , | ||
54 | .Nm strstr , | ||
55 | .Nm strtok , | ||
56 | .Nm index , | ||
57 | .Nm rindex | ||
58 | .Nd string specific functions | ||
59 | .Sh SYNOPSIS | ||
60 | .Fd #include <string.h> | ||
61 | .Ft char * | ||
62 | .Fn strcat "char *s" "const char *append" | ||
63 | .Ft char * | ||
64 | .Fn strlcat "char *s" "const char *append" "size_t size" | ||
65 | .Ft char * | ||
66 | .Fn strncat "char *s" "const char *append" "size_t count" | ||
67 | .Ft char * | ||
68 | .Fn strchr "const char *s" "int c" | ||
69 | .Ft char * | ||
70 | .Fn strrchr "const char *s" "int c" | ||
71 | .Ft int | ||
72 | .Fn strcmp "const char *s1" "const char *s2" | ||
73 | .Ft int | ||
74 | .Fn strncmp "const char *s1" "const char *s2" "size_t count" | ||
75 | .Ft int | ||
76 | .Fn strcasecmp "const char *s1" "const char *s2" | ||
77 | .Ft int | ||
78 | .Fn strncasecmp "const char *s1" "const char *s2" "size_t count" | ||
79 | .Ft char * | ||
80 | .Fn strcpy "char *dst" "const char *src" | ||
81 | .Ft char * | ||
82 | .Fn strlcpy "char *dst" "const char *src" "size_t size" | ||
83 | .Ft char * | ||
84 | .Fn strncpy "char *dst" "const char *src" "size_t count" | ||
85 | .Ft char * | ||
86 | .Fn strerror "int errno" | ||
87 | .Ft size_t | ||
88 | .Fn strlen "const char *s" | ||
89 | .Ft char * | ||
90 | .Fn strpbrk "const char *s" "const char *charset" | ||
91 | .Ft char * | ||
92 | .Fn strsep "char **stringp" "const char *delim" | ||
93 | .Ft size_t | ||
94 | .Fn strspn "const char *s" "const char *charset" | ||
95 | .Ft size_t | ||
96 | .Fn strcspn "const char *s" "const char *charset" | ||
97 | .Ft char * | ||
98 | .Fn strstr "const char *big" "const char *little" | ||
99 | .Ft char * | ||
100 | .Fn strtok "char *s" "const char *delim" | ||
101 | .Ft char * | ||
102 | .Fn index "const char *s" "int c" | ||
103 | .Ft char * | ||
104 | .Fn rindex "const char *s" "int c" | ||
105 | .Sh DESCRIPTION | ||
106 | The string functions | ||
107 | manipulate strings terminated by a | ||
108 | null byte. | ||
109 | .Pp | ||
110 | See the specific manual pages for more information. | ||
111 | For manipulating variable length generic objects as byte | ||
112 | strings (without the null byte check), see | ||
113 | .Xr bstring 3 . | ||
114 | .Pp | ||
115 | Except as noted in their specific manual pages, | ||
116 | the string functions do not test the destination | ||
117 | for size limitations. | ||
118 | .Sh SEE ALSO | ||
119 | .Xr bstring 3 , | ||
120 | .Xr index 3 , | ||
121 | .Xr rindex 3 , | ||
122 | .Xr strcasecmp 3 , | ||
123 | .Xr strcat 3 , | ||
124 | .Xr strchr 3 , | ||
125 | .Xr strcmp 3 , | ||
126 | .Xr strcpy 3 , | ||
127 | .Xr strcspn 3 , | ||
128 | .Xr strerror 3 , | ||
129 | .Xr strlcat 3 , | ||
130 | .Xr strlcpy 3 , | ||
131 | .Xr strlen 3 , | ||
132 | .Xr strpbrk 3 , | ||
133 | .Xr strrchr 3 , | ||
134 | .Xr strsep 3 , | ||
135 | .Xr strspn 3 , | ||
136 | .Xr strstr 3 , | ||
137 | .Xr strtok 3 | ||
138 | .Sh STANDARDS | ||
139 | The | ||
140 | .Fn strcat , | ||
141 | .Fn strncat , | ||
142 | .Fn strchr , | ||
143 | .Fn strrchr , | ||
144 | .Fn strcmp , | ||
145 | .Fn strncmp , | ||
146 | .Fn strcpy , | ||
147 | .Fn strncpy , | ||
148 | .Fn strerror , | ||
149 | .Fn strlen , | ||
150 | .Fn strpbrk , | ||
151 | .Fn strspn , | ||
152 | .Fn strcspn , | ||
153 | .Fn strstr , | ||
154 | and | ||
155 | .Fn strtok | ||
156 | functions conform to | ||
157 | .St -ansiC . | ||