Bug 157078

Summary:

[patch] su.1: clarify use of -c as shell argument

Product:

Documentation

Reporter:

Warren Block <wblock>

Component:

Books & Articles

Assignee:

Glen Barber <gjb>

Status:

Closed FIXED

Severity:

Affects Only Me

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
file.diff	none

Description Warren Block 2011-05-16 01:00:25 UTC

su(1) uses -c in an example, but does not explain that it is passed to a shell, not su's -c option.

Fix: Apply patch.

Patch attached with submission follows:
How-To-Repeat: Compare the description of su's -c option in su.1 with the use of -c in the first example.

Comment 1 Glen Barber freebsd_committer

2011-06-06 15:42:58 UTC

Responsible Changed
From-To: freebsd-doc->gjb

I'll take this.

Comment 2 dfilter service freebsd_committer

2011-06-06 16:18:10 UTC

Author: gjb (doc committer)
Date: Mon Jun  6 15:17:55 2011
New Revision: 222758
URL: http://svn.freebsd.org/changeset/base/222758

Log:
  Document that when running 'su -m <user> -c <command>', <command> is run
  within a shell as <user>.
  
  PR:		157078
  Submitted by:	Warren Block <wblock@wonkity.com>
  MFC after:	5 days

Modified:
  head/usr.bin/su/su.1

Modified: head/usr.bin/su/su.1
==============================================================================
--- head/usr.bin/su/su.1	Mon Jun  6 14:46:43 2011	(r222757)
+++ head/usr.bin/su/su.1	Mon Jun  6 15:17:55 2011	(r222758)
@@ -193,10 +193,10 @@ PAM configuration for
 .Sh EXAMPLES
 .Bl -tag -width 5n -compact
 .It Li "su -m man -c catman"
-Runs the command
-.Li catman
-as user
-.Li man .
+Starts a shell as user
+.Li man ,
+and runs the command
+.Li catman .
 You will be asked for man's password unless your real UID is 0.
 Note that the
 .Fl m
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 3 Glen Barber freebsd_committer

2011-06-06 16:18:13 UTC

State Changed
From-To: open->patched

Patched in head with minor rewording.  MFC in 5 days.

Comment 4 Glen Barber freebsd_committer

2011-06-11 01:31:47 UTC

State Changed
From-To: patched->closed

MFCd to stable/8 and stable/7.

Comment 5 dfilter service freebsd_committer

2011-06-11 01:32:48 UTC

Author: gjb (doc committer)
Date: Sat Jun 11 00:30:56 2011
New Revision: 222965
URL: http://svn.freebsd.org/changeset/base/222965

Log:
  MFC 222758, 222759, 222770:
  
  - Document that when running 'su -m <user> -c <command>', <command> is
    run within a shell as <user>.
  - Bump date
  - Attempt to clear up some confusion in the following example, by
    stating the '-c' argument is passed to the shell, not to su(1), which
    would indicate the login class.
  
        'su -m <user> -c <command>'
  
  PR:		157078

Modified:
  stable/8/usr.bin/su/su.1
Directory Properties:
  stable/8/usr.bin/su/   (props changed)

Modified: stable/8/usr.bin/su/su.1
==============================================================================
--- stable/8/usr.bin/su/su.1	Sat Jun 11 00:06:14 2011	(r222964)
+++ stable/8/usr.bin/su/su.1	Sat Jun 11 00:30:56 2011	(r222965)
@@ -32,7 +32,7 @@
 .\"	@(#)su.1	8.2 (Berkeley) 4/18/94
 .\" $FreeBSD$
 .\"
-.Dd July 1, 2008
+.Dd June 6, 2011
 .Dt SU 1
 .Os
 .Sh NAME
@@ -197,16 +197,22 @@ PAM configuration for
 .Sh EXAMPLES
 .Bl -tag -width 5n -compact
 .It Li "su -m man -c catman"
-Runs the command
-.Li catman
-as user
-.Li man .
+Starts a shell as user
+.Li man ,
+and runs the command
+.Li catman .
 You will be asked for man's password unless your real UID is 0.
 Note that the
 .Fl m
 option is required since user
 .Dq man
 does not have a valid shell by default.
+In this example,
+.Fl c
+is passed to the shell of the user
+.Dq man ,
+and is not interpreted as an argument to
+.Nm .
 .It Li "su -m man -c 'catman /usr/share/man /usr/local/man'"
 Same as above, but the target command consists of more than a
 single word and hence is quoted for use with the
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"

Comment 6 dfilter service freebsd_committer

2011-06-11 01:33:13 UTC

Author: gjb (doc committer)
Date: Sat Jun 11 00:31:37 2011
New Revision: 222966
URL: http://svn.freebsd.org/changeset/base/222966

Log:
  MFC 222758, 222759, 222770:
  
  - Document that when running 'su -m <user> -c <command>', <command> is
    run within a shell as <user>.
  - Bump date
  - Attempt to clear up some confusion in the following example, by
    stating the '-c' argument is passed to the shell, not to su(1), which
    would indicate the login class.
  
        'su -m <user> -c <command>'
  
  PR:		157078

Modified:
  stable/7/usr.bin/su/su.1
Directory Properties:
  stable/7/usr.bin/su/   (props changed)

Modified: stable/7/usr.bin/su/su.1
==============================================================================
--- stable/7/usr.bin/su/su.1	Sat Jun 11 00:30:56 2011	(r222965)
+++ stable/7/usr.bin/su/su.1	Sat Jun 11 00:31:37 2011	(r222966)
@@ -32,7 +32,7 @@
 .\"	@(#)su.1	8.2 (Berkeley) 4/18/94
 .\" $FreeBSD$
 .\"
-.Dd July 1, 2008
+.Dd June 6, 2011
 .Dt SU 1
 .Os
 .Sh NAME
@@ -197,16 +197,22 @@ PAM configuration for
 .Sh EXAMPLES
 .Bl -tag -width 5n -compact
 .It Li "su -m man -c catman"
-Runs the command
-.Li catman
-as user
-.Li man .
+Starts a shell as user
+.Li man ,
+and runs the command
+.Li catman .
 You will be asked for man's password unless your real UID is 0.
 Note that the
 .Fl m
 option is required since user
 .Dq man
 does not have a valid shell by default.
+In this example,
+.Fl c
+is passed to the shell of the user
+.Dq man ,
+and is not interpreted as an argument to
+.Nm .
 .It Li "su -m man -c 'catman /usr/share/man /usr/local/man'"
 Same as above, but the target command consists of more than a
 single word and hence is quoted for use with the
_______________________________________________
svn-src-all@freebsd.org mailing list
http://lists.freebsd.org/mailman/listinfo/svn-src-all
To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"