Date: Sun, 14 Aug 2005 09:10:29 -0700 From: "Gary W. Swearingen" <garys@opusnet.com> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/84914: [patch] sh(1) manpage omits ways to escape an alias name Message-ID: <jkacjkfqiy.cjk@mail.opusnet.com> Resent-Message-ID: <200508141610.j7EGAFuE066781@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 84914 >Category: docs >Synopsis: [patch] sh(1) manpage omits ways to escape an alias name >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Sun Aug 14 16:10:15 GMT 2005 >Closed-Date: >Last-Modified: >Originator: Gary W. Swearingen >Release: HEAD 08'aug'05 >Organization: none >Environment: n/a >Description: The sh(1) manpage fails to discuss the ways to escape an alias invocation. Also, the alias syntax lines are not quite right. Also, the alias command description doesn't refer to the "Aliases" subsection. >How-To-Repeat: n/a >Fix: --- sh..orig.1 Tue Jun 14 01:25:00 2005 +++ sh.1 Mon Aug 8 11:52:55 2005 @@ -355,8 +355,9 @@ .El .Ss Quoting Quoting is used to remove the special meaning of certain characters -or words to the shell, such as operators, whitespace, or -keywords. +or words to the shell, such as operators, whitespace, keywords, +or alias names. +.Pp There are three types of quoting: matched single quotes, matched double quotes, and backslash. .Bl -tag -width indent @@ -422,6 +423,15 @@ They can also be used to create lexically obscure code. This use is discouraged. +.Pp +An alias name may be escaped in a command line, so that it is not +replaced by its alias value, by using quoting characters within or +adjacent to the alias name. This is most often done by prefixing +an alias name with a backslash to execute a function, built-in, or +normal program with the same name. +See the +.Sx Quoting +subsection. .Ss Commands The shell interprets the words it reads according to a language, the specification of which is outside the scope @@ -1352,8 +1362,7 @@ If it is not found in the .Ev PATH , it is sought in the current working directory. -.It Ic alias Op Ar name ... -.It Ic alias Op Ar name Ns = Ns Ar string ... +.It Ic alias Oo Ar name Ns Oo = Ns Ar string Oc ... Oc If .Ar name Ns = Ns Ar string is specified, the shell defines the alias @@ -1372,6 +1381,9 @@ .Ic unalias ) . Alias values are written with appropriate quoting so that they are suitable for re-input to the shell. +Also see the +.Sx Aliases +subsection. .It Ic bg Op Ar job ... Continue the specified jobs (or the current job if no jobs are given) >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?jkacjkfqiy.cjk>