From nobody Mon Apr 8 16:38:56 2024 X-Original-To: dev-commits-src-all@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 4VCvtS6GkRz5HKfw; Mon, 8 Apr 2024 16:38:56 +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 "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4VCvtS5ll4z4LVS; Mon, 8 Apr 2024 16:38:56 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1712594336; 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=2THbpjoHesThy7yn1clvBYFzcNi/kr261pXDiBe/MEQ=; b=VrMapW+64XchSE3YNdeR+gSQ/AjRlgos31S7HE0a+x6eWARLT1jvlS+iKvxeaZPGh/63vM bTuRZ/E+ja7LfBZXJG7fQpG1ZSHFg53Y9TF9l/Ze1BreuZj7beXX9oAhOUMzt+dbC2ilSt 8wW6d1O4kql5EIw04p0+RS5uGmj3j4SHLz+fkIpsYadEDgA87agbHQx8TJ2+MrS7PBMMYJ Ux1IM8GfI+QfNXZ4jnVyiS36fMdPd2I/O/YpIz28sd4bQMkwsgEHug+5ccHYKlsFDbYwgi 7/sHYYtEHtnZ8eJ90gYuMWnTvJJDPk9KCifxFwiTeXk/LFArB+8XG8UMMEkuRQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1712594336; a=rsa-sha256; cv=none; b=fwimbAppKjg4NRYRX8vFWXKO9EOyz4NHub9QdoLK1C9ybpLaKel4bZU+52NjJIh2jFr+xy ihMvm9oXn9PcY2vL/6xiqcTZoRy/EgoiK72ESrGWLKFAKFDKwPJpCf4a/E3fxXVzMHAorg ApuTbvZEgLroTG89uclI6bgOzqBsNwH3Qpk+4jHRHFbjkmxC936TdH4gg4AhqDW8VSbH6I Ri6exPIr0tuLcD8mP98HNiMFlrE8akJatEG/qCorhnTlu/W2dmQTONnJ5yrEFWNs66otM6 7I+9g8+U2JDPlQ6eJvC2z8kt9mT5Jm6LIRhTBDsjSHn/kUfpLEE2SNHvZHCnLQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1712594336; 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=2THbpjoHesThy7yn1clvBYFzcNi/kr261pXDiBe/MEQ=; b=R8iOluwJEnVonCbL813lIYs0tJ+DW2Y29e9dvD2gW0YUE+eBCkz+Qw72c3KQu3qrrDRBvp 82/qTYFFVevvthA62QKn5iOhk+Cr5E9wbwbb5/lcl4ZD+piBXJZg5AgnA26xFj0qYutq2T zqvMZxY74dt1Okckk78FE9zKUpocfSvaPvs+jBn1RlLa8XduuWbpPQGNGnuwGcAESXorIg juWODkjiA8FTKKVVdIbtcIHym087pWiYmqinmM1P65TY2cAvlC6BDmY2Fcni2PPGKFJw4B fzINa5lX61EZhy6zzeEId0wESuAkrjEYflQIIgKTCw0W5XAY3JgQ5fUA9GfAyg== 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 4VCvtS5DfjzJ20; Mon, 8 Apr 2024 16:38:56 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.17.1/8.17.1) with ESMTP id 438Gcu90038976; Mon, 8 Apr 2024 16:38:56 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.17.1/8.17.1/Submit) id 438GcuSm038973; Mon, 8 Apr 2024 16:38:56 GMT (envelope-from git) Date: Mon, 8 Apr 2024 16:38:56 GMT Message-Id: <202404081638.438GcuSm038973@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Fernando =?utf-8?Q?Apestegu=C3=ADa?= Subject: git: 7e68976408e4 - main - echo(1): Add EXAMPLES List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 7e68976408e4df21e120e2d6440392302cac84f3 Auto-Submitted: auto-generated The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/src/commit/?id=7e68976408e4df21e120e2d6440392302cac84f3 commit 7e68976408e4df21e120e2d6440392302cac84f3 Author: Fernando Apesteguía AuthorDate: 2023-09-07 13:27:49 +0000 Commit: Fernando Apesteguía CommitDate: 2024-04-08 16:35:40 +0000 echo(1): Add EXAMPLES While here add CAVEAT section and promote the use of printf(1) Reviewed by: gbe@, imp@ Approved by: manpages (gbe) Differential Revision: https://reviews.freebsd.org/D43493 --- bin/echo/echo.1 | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/bin/echo/echo.1 b/bin/echo/echo.1 index aa547d2350f5..cb60bdcc88dd 100644 --- a/bin/echo/echo.1 +++ b/bin/echo/echo.1 @@ -89,6 +89,24 @@ Consult the manual page. .Sh EXIT STATUS .Ex -std +.Sh EXAMPLES +Special treatment of options and backslashes: +.Bd -literal -offset indent +$ /bin/echo "-hello\\tworld" +-hello\tworld +.Ed +.Pp +Avoid new line character: +.Bd -literal -offset indent +$ /bin/echo -n hello;/bin/echo world +helloworld +.Ed +.Pp +Or to achieve the same result: +.Bd -literal -offset indent +$ /bin/echo "hello\\c";/bin/echo world +helloworld +.Ed .Sh SEE ALSO .Xr builtin 1 , .Xr csh 1 , @@ -105,3 +123,14 @@ The .Nm command appeared in .At v2 . +.Sh CAVEATS +The +.Nm +command behaves differently with regards to the built-in +.Nm +shell command in a number of ways including escaped characters handling. +It also differs in behavior between different systems hence complicating writing +portable scripts. +It is advised to use the +.Xr printf 1 +command to avoid these shortcomings.