diff options
Diffstat (limited to 'doc/argot_strdup.3')
-rw-r--r-- | doc/argot_strdup.3 | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/doc/argot_strdup.3 b/doc/argot_strdup.3 new file mode 100644 index 0000000..ce53b07 --- /dev/null +++ b/doc/argot_strdup.3 | |||
@@ -0,0 +1,68 @@ | |||
1 | .\" This file is part of argot -*- nroff -*- | ||
2 | .\" Copyright (C) 2007-2016 Sergey Poznyakoff | ||
3 | .\" | ||
4 | .\" Grecs is free software; you can redistribute it and/or modify | ||
5 | .\" it under the terms of the GNU General Public License as published by | ||
6 | .\" the Free Software Foundation; either version 3, or (at your option) | ||
7 | .\" any later version. | ||
8 | .\" | ||
9 | .\" Grecs is distributed in the hope that it will be useful, | ||
10 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | .\" GNU General Public License for more details. | ||
13 | .\" | ||
14 | .\" You should have received a copy of the GNU General Public License | ||
15 | .\" along with Grecs. If not, see <http://www.gnu.org/licenses/>. | ||
16 | .\" | ||
17 | .TH ARGOT_STRDUP 3 "May 7, 2011" "ARGOT" "Grecs User Reference" | ||
18 | .SH NAME | ||
19 | argot_strdup \- duplicate a string | ||
20 | .SH SYNOPSIS | ||
21 | .nf | ||
22 | .B #include <argot.h> | ||
23 | .sp | ||
24 | .BI "char *argot_strdup(const char *" "str" ); | ||
25 | |||
26 | .SH DESCRIPTION | ||
27 | The | ||
28 | .BR strdup () | ||
29 | function returns a pointer to a new string which is a duplicate of the | ||
30 | string \fIstr\fR. Memory for the new string is obtained with | ||
31 | .BR argot_malloc (3), | ||
32 | and must be freed with | ||
33 | .BR argot_free (3). | ||
34 | .SH "RETURN VALUE" | ||
35 | The | ||
36 | .BR argot_strdup () | ||
37 | function returns a pointer to the duplicated string. | ||
38 | .PP | ||
39 | On error, | ||
40 | .BR argot_alloc_die (3) | ||
41 | is called, which terminates the program. | ||
42 | .SH "SEE ALSO" | ||
43 | .BR argot_alloc_die (3) | ||
44 | .SH AUTHORS | ||
45 | Sergey Poznyakoff | ||
46 | .SH "BUG REPORTS" | ||
47 | Report bugs to <gray+argot@gnu.org.ua>. | ||
48 | .SH COLOPHON | ||
49 | The \fBGrecs\fR library is constantly changing, so this manual page | ||
50 | may be incorrect or out-of-date. For the latest copy of \fBGrecs\fR | ||
51 | documentation, visit <http://www.gnu.org.ua/software/argot>. | ||
52 | .SH COPYRIGHT | ||
53 | Copyright \(co 2011 Sergey Poznyakoff | ||
54 | .br | ||
55 | .na | ||
56 | License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html> | ||
57 | .br | ||
58 | .ad | ||
59 | This is free software: you are free to change and redistribute it. | ||
60 | There is NO WARRANTY, to the extent permitted by law. | ||
61 | .\" Local variables: | ||
62 | .\" eval: (add-hook 'write-file-hooks 'time-stamp) | ||
63 | .\" time-stamp-start: ".TH [A-Z_][A-Z0-9_]* [0-9] \"" | ||
64 | .\" time-stamp-format: "%:B %:d, %:y" | ||
65 | .\" time-stamp-end: "\"" | ||
66 | .\" time-stamp-line-limit: 20 | ||
67 | .\" end: | ||
68 | |||