On 12/05/13 01:03, Moritz.Struebe@xxxxxxxxxxxxxxxxxxxxxxxxxx wrote: > From: Moritz 'Morty' Strübe <morty@xxxxxxx> > > It is helpful to have a short description about what the different > functions in string.h do. Hello Moritz, Thanks for the idea and the patch. I agree with you. I applied your patch. There were, however, a few inaccuracies in your descriptions which I've hopefully fixed. I also further expanded some of the descriptions. Cheers, Michael > Signed-off-by: Moritz 'Morty' Strübe <morty@xxxxxxx> > --- > man3/string.3 | 159 +++++++++++++++++++++++++++++++++++++++++++++++---------- > 1 file changed, 133 insertions(+), 26 deletions(-) > > diff --git a/man3/string.3 b/man3/string.3 > index b180a50..5e27a65 100644 > --- a/man3/string.3 > +++ b/man3/string.3 > @@ -34,58 +34,165 @@ strdup, strfry, strlen, strncat, strncmp, strncpy, strncasecmp, strpbrk, > strrchr, strsep, strspn, strstr, strtok, strxfrm, index, rindex > \- string operations > .SH SYNOPSIS > -.nf > .B #include <strings.h> > -.sp > +.TP > .BI "int strcasecmp(const char *" s1 ", const char *" s2 ); > -.sp > +Compares > +.I s1 > +and > +.I s2 > +ignoring the case. > +.TP > .BI "int strncasecmp(const char *" s1 ", const char *" s2 ", size_t " n ); > -.sp > +Compares the first > +.I n > +characters of > +.I s1 > +and > +.I s2 > +ignoring the case. > +.TP > .BI "char *index(const char *" s ", int " c ); > -.sp > +Returns the first occurrence of > +.I c > +in > +.IR s . > +.TP > .BI "char *rindex(const char *" s ", int " c ); > -.sp > +Returns the last occurrence of > +.I c > +in > +.IR s . > +.TP > +.TP > .B #include <string.h> > -.sp > +.TP > +.TP > .BI "char *stpcpy(char *" dest ", const char *" src ); > -.sp > +Copy a string from > +.I src > +to > +.IR dest . > +.TP > .BI "char *strcat(char *" dest ", const char *" src ); > -.sp > +Concatenate > +.I src > +to > +.IR dest . > +.TP > .BI "char *strchr(const char *" s ", int " c ); > -.sp > +Find the first occurence of > +.I c > +in > +.IR s . > +.TP > .BI "int strcmp(const char *" s1 ", const char *" s2 ); > -.sp > +Compare > +.I s1 > +with > +.IR s2. > +.TP > .BI "int strcoll(const char *" s1 ", const char *" s2 ); > -.sp > +Compare > +.I s1 > +with > +.I s2 > +using the current locale. > +.TP > .BI "char *strcpy(char *" dest ", const char *" src ); > -.sp > +Copy > +.I src > +to > +.IR dst . > +.TP > .BI "size_t strcspn(const char *" s ", const char *" reject ); > -.sp > +Calculate the length of the initial segment of > +.I s > +which does not contain > +.IR reject . > +.TP > .BI "char *strdup(const char *" s ); > -.sp > +Copy > +.I s > +to memory allocated using > +.IR malloc (3). > +.TP > .BI "char *strfry(char *" string ); > -.sp > +Randomly swap the characters in > +.IR string. > +.TP > .BI "size_t strlen(const char *" s ); > -.sp > +Calculate the length of > +.IR s . > +.TP > .BI "char *strncat(char *" dest ", const char *" src ", size_t " n ); > -.sp > +Copy at most > +.I n > +characters from > +.I src > +to > +.IR dest . > +.TP > .BI "int strncmp(const char *" s1 ", const char *" s2 ", size_t " n ); > -.sp > +Compare at most > +.I n > +bytes of > +.I s1 > +and > +.IR s2. > +.TP > .BI "char *strncpy(char *" dest ", const char *" src ", size_t " n ); > -.sp > +Copy at most > +.I n > +bytes > +from > +.I src > +to > +.IR dst . > +.TP > .BI "char *strpbrk(const char *" s ", const char *" accept ); > -.sp > +Return the first occurrence of > +.I s > +in > +.IR accept . > +.TP > .BI "char *strrchr(const char *" s ", int " c ); > -.sp > +Return the first occurrence of > +.I s > +in > +.IR c . > +.TP > .BI "char *strsep(char **" stringp ", const char *" delim ); > -.sp > +Tokenise > +.I stringp > +at > +.IR delim . > +.TP > .BI "size_t strspn(const char *" s ", const char *" accept ); > -.sp > +Calculate the size of the starting segment in > +.I s > +that consists of > +.IR accept . > +.TP > .BI "char *strstr(const char *" haystack ", const char *" needle ); > -.sp > +Find the first occurrence of > +.I needle > +in > +.IR haystack . > +.TP > .BI "char *strtok(char *" s ", const char *" delim ); > -.sp > +Tokenize > +.I s > +at > +.IR delim . > +.TP > .BI "size_t strxfrm(char *" dest ", const char *" src ", size_t " n ); > +Transforms > +.I src > +to the current locale and copies the first > +.I n > +characters to > +.IR dest . > .fi > .SH DESCRIPTION > The string functions perform string operations on null-terminated > -- Michael Kerrisk Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/ Linux/UNIX System Programming Training: http://man7.org/training/ -- To unsubscribe from this list: send the line "unsubscribe linux-man" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
