From nobody Sun Nov 02 19:22:00 2025 X-Original-To: dev-commits-src-main@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4d04N83Glzz6FKGr; Sun, 02 Nov 2025 19:22:00 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4d04N82W2Rz3XV0; Sun, 02 Nov 2025 19:22:00 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762111320; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=NzybPUgxpSx6qlOphxJ6AUcEYzw0FFjnkwPUptjAdJs=; b=B65rJFKK87lqELUUPByEOA8yLOLZDmoIVSl2ZIM6prN389hk8UZNFEEZWqWymTOX8bshrY rY5M+RrZYoXASbCZE5Wy3K0E2Q6HceCNkpMTWpIQGn+xT8NyYd+E7olmASlPgze4UGFJuX LWKFVuzrDBVcaY2LdLjw7d9VyN4skGI+wSI/chj1usPAP7GCja5Ueq/l7ko342Fir5NVrb BzE8uLpYPo3FgPTHuBMuy8BamV/rWNeuAhgrut9N+n7uPA//KsihJ5ux8X/WwJUM9ExswJ VKAOC09bG9zFU09tGoWXwUk1vw4MrDi8meHbckki42YpQnRHyK7m6XKFqadlQg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1762111320; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=NzybPUgxpSx6qlOphxJ6AUcEYzw0FFjnkwPUptjAdJs=; b=b5Ayh5DhE9cE42cxIumC3gLl+V6IP6LNpY0nVvdkK5yEYgJ/Y1GT960hSiS2FuLACtCNmm 8DZSpAZpJ1KhrRnJJ+8HtwuYMF0QdH6MyekDprVRz6/nWuzZzz7QqGSW3Mtby0W7PvRFa9 +kxBjzU8UYiRGZm9usqgtXmLnHhToB5RpaUy9mi53BGksUzkHmTQFHlwz1TKJWvXlyQ8lL OPHbKQoH3uxUAi7PbsB9iUNFSo43eTN2AFyq8tHNUsUx4ajU4Di/VN33P+CGkWeE4Lhg+k UC6ETaVzNrSHcneHND61UlAL+6obvHsPBmJGH4qGplCSqifybEqPsD8smniPrw== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1762111320; a=rsa-sha256; cv=none; b=lqPU9BGSHfE5nGUeqGUwf2tDnYohThsbLuDl4TBIfwOSQIOkD2bapnKDeU3AbxlRV/WrIp mxx+LSLF0gSFHk+TUnaZ22g379Z7Tl0rimZOfGNTh9WCV5B6VMzgnwnNawKDYZVd172Bg/ 8fWlQ9aOAspiikzLRB+WHwVy4CsBQtGeVIXIqbYnKUFa4sqvlVz2EmTA+sj6O/8Ynq7uub KdTdgVWFLVVmicsQXy7Bcz+aERnMHjX07BroqhvhsLA3Gwp2huOmrHAKIhABxv7CMQ+eSo Pmq5JTV4eGDay8AelCtE6foLSqJsG1elKlScykMaKyy5czA3OILDIbbCuK8Nsw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4d04N823SzzfVc; Sun, 02 Nov 2025 19:22:00 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 5A2JM0a5022256; Sun, 2 Nov 2025 19:22:00 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 5A2JM0OD022253; Sun, 2 Nov 2025 19:22:00 GMT (envelope-from git) Date: Sun, 2 Nov 2025 19:22:00 GMT Message-Id: <202511021922.5A2JM0OD022253@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: af99c4c1d03c - main - d.7: Document strchr, strjoin, strrchr, strstr, strtok, strlen, and substr List-Id: Commit messages for the main branch of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-main List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-main@freebsd.org Sender: owner-dev-commits-src-main@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: af99c4c1d03c742faf8bd4c62fbbb664c5f7fc18 Auto-Submitted: auto-generated The branch main has been updated by 0mp: URL: https://cgit.FreeBSD.org/src/commit/?id=af99c4c1d03c742faf8bd4c62fbbb664c5f7fc18 commit af99c4c1d03c742faf8bd4c62fbbb664c5f7fc18 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2025-10-28 20:06:53 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2025-11-02 19:21:30 +0000 d.7: Document strchr, strjoin, strrchr, strstr, strtok, strlen, and substr Reviewed by: markj MFC after: 2 weeks Differential Revision: https://reviews.freebsd.org/D53417 --- share/man/man7/d.7 | 124 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 124 insertions(+) diff --git a/share/man/man7/d.7 b/share/man/man7/d.7 index 4b00d3d71c79..59b3389b121b 100644 --- a/share/man/man7/d.7 +++ b/share/man/man7/d.7 @@ -198,6 +198,130 @@ The number of nanoseconds since the Epoch Suitable for timestamping logs. .El .Sh BUILT-IN FUNCTIONS +.\" Keep the indentation wide enough for the reader to be able to skim through +.\" function names quickly. +.Bl -tag -width "size_t strlen" +.It Ft string Fn strchr "string s" "char c" +Return a substring of +.Fa s +starting at the first occurance of +.Fa c +in +.Fa s . +Return +.Dv NULL +if +.Fa c +does not occur in +.Fa s . +.Pp +For example, +.Bd -literal -compact -offset indent +strchr("abc", 'b'); +.Ed +returns +.Ql "bc" +and +.Bd -literal -compact -offset indent +strchr("abc", 'd'); +.Ed +returns +.Dv NULL . +.It Ft string Fn strjoin "string s1" "string s2" +Return a string resulting from concatenating +.Fa s1 +and +.Fa s2 . +.Pp +For example, +.Bd -literal -compact -offset indent +strjoin("abc", "def") +.Ed +returns +.Ql abcdef . +.It Ft string Fn strrchr "string s" "char c" +Return a substring of +.Fa s +starting at the last occurance of +.Fa c +in +.Fa s . +Similar to +.Fn strchr . +.It Ft string Fn strstr "string haystack" "string needle" +Return a substring of +.Fa haystack +starting at the first occurrence of +.Fa needle . +Return +.Dv NULL +if +.Fa needle +is not a substring of +.Fa haystack . +.Pp +For example, +.Bd -literal -compact -offset indent +strstr("abc1bc2", "bc") +.Ed +returns +.Ql bc1bc2 +and +.Bd -literal -compact -offset indent +strstr("abc", "xy") +.Ed +returns +.Dv NULL . +.It Ft string Fn strtok "string s" "string separators" +Tokenize +.Fa s +with +.Fa separators . +.Pp +For example, +.Bd -literal -compact -offset indent +strtok("abcdefg", "xyzd") +.Ed +returns +.Ql abc . +.It Ft size_t Fn strlen "string s" +Return the length of string +.Fa s . +.It Ft string Fn substr "string s" "int position" "[int length]" +Return a +substring of string +.Fa s +starting at +.Fa position . +The substring will be at most +.Fa length Ns -long . +If +.Fa length +is not specified, use the rest of the string. +If +.Fa position +is greater than +the size of +.Fa s , +return an empty string. +.Pp +For example, +.Bd -literal -compact -offset indent +substr("abcd", 2) +.Ed +returns +.Ql cd , +.Bd -literal -compact -offset indent +substr("abcd", 2, 1) +.Ed +returns +.Ql c , +and +.Bd -literal -compact -offset indent +substr("abcd", 99) +.Ed +returns an empty string. +.El .Ss Aggregation Functions .Bl -tag -compact -width "llquantize(value, factor, low, high, nsteps)" .It Fn avg value