Bug 4954 - Extension of manual
Summary: Extension of manual
Status: Closed FIXED
Alias: None
Product: Base System
Classification: Unclassified
Component: bin (show other bugs)
Version: 2.2.2-RELEASE
Hardware: Any Any
: Normal Affects Only Me
Assignee: Steve Price
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 1997-11-05 22:30 UTC by jhs
Modified: 1997-11-16 13:29 UTC (History)
1 user (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description jhs freebsd_committer freebsd_triage 1997-11-05 22:30:00 UTC
	Extension of manual.
	I was reminded of writing this by a post to current from
	"John Brown" <jbrown@vafibre.com>

Fix: Ive had the following patch in
	http://www.freebsd.org/~jhs/src/bsd/fixes/FreeBSD/\
		src/gen/usr.bin/rdist/rdist.1.diff
	since at least March 97 but not sent it in via send-pr till now, Sorry.
============
Extension of manual



============

Julian
--
Julian H. Stacey
Home <jhs@freebsd.org>     http://www.freebsd.org/~jhs/     Tel. +49 89 268616--PPw8muKotGXLzLMvxHSCHFXmQEPNRXhdAKVrEA5K4jm4VVte
Content-Type: text/plain; name="file.diff"
Content-Transfer-Encoding: 7bit
Content-Disposition: attachment; filename="file.diff"

*** old/src/usr.bin/rdist/rdist.1.~1~	Tue Jan 21 19:07:53 1997
--- old/src/usr.bin/rdist/rdist.1	Mon Mar 31 14:07:57 1997
***************
*** 400,409 ****
  .Sh DIAGNOSTICS
  A complaint about mismatch of rdist version numbers may really stem
  from some problem with starting your shell, e.g., you are in too many groups.
  .Sh BUGS
  Source files must reside on the local host where
  .Nm rdist
! is executed.
  .Pp
  There is no easy way to have a special command executed after all files
  in a directory have been updated.
--- 400,436 ----
  .Sh DIAGNOSTICS
  A complaint about mismatch of rdist version numbers may really stem
  from some problem with starting your shell, e.g., you are in too many groups.
+ .Pp
+ .Nm Rdist
+ relies on
+ .Nm rsh(1)
+ type remote services executing succesfully & in silence.
+ If you try something like
+ .Bd -literal -offset indent
+ rsh freefall.freebsd.org hostname  
+ .Ed
+ .sp
+ & get extra output before the program (
+ .Nm hostname(1)
+ ) output, such as
+ .Bd -literal -offset indent
+ Text_perhaps_initiated_from_~/.cshrc_or_similar
+ freefall.freebsd.org  
+ .Ed
+ .sp
+ then the unexpected extra text will cause
+ .Nm rdist
+ to fail with the error message:
+ .Bd -literal -offset indent
+ rdist: connection failed: version numbers don't match
+ .Ed
+ .sp
  .Sh BUGS
  Source files must reside on the local host where
  .Nm rdist
! is executed
! (Note, a ~/public_html that is a symbolic link via NFS to another local host is not
! considered local by rdist, so rdist will not copy it to the remote rdist destination).
  .Pp
  There is no easy way to have a special command executed after all files
  in a directory have been updated.
How-To-Repeat: 	-
Comment 1 Garrett A. Wollman 1997-11-06 02:50:14 UTC
<<On Tue, 4 Nov 1997 21:57:33 +0100 (MET), jhs@FreeBSD.ORG said:

> + .Nm Rdist
> + relies on
> + .Nm rsh(1)

BZZT!
.Xr rsh 1
(or, more accurately,
.Xr rcmd 3 )

> + type remote services executing succesfully & in silence.

Spelling: it's ``successfully'' and ``and''.

> + If you try something like
> + .Bd -literal -offset indent
> + rsh freefall.freebsd.org hostname  
> + .Ed
> + .sp

Never, ever, ever bare troff requsts like `.sp' in man pages.

> + & get extra output before the program (
> + .Nm hostname(1)
> + ) output, such as

.Pq Xr hostname 1
(if anything)

> + .Bd -literal -offset indent
> + Text_perhaps_initiated_from_~/.cshrc_or_similar
> + freefall.freebsd.org  
> + .Ed

A display is probably not the right structure, semantically, for this
purpose.  Instead, it should simply be noted that a common error is
for non-interactive initialization scripts, like
.Pa .cshrc ,
to generate output (or to run other programs which generate output
when not attached to a terminal---the most frequent offender is
.Xr stty 1 .

> + .Bd -literal -offset indent
> + rdist: connection failed: version numbers don't match
> + .Ed
> + .sp

Should use a one-line display.

>   .Sh BUGS
>   Source files must reside on the local host where
>   .Nm rdist
> ! is executed
> ! (Note, a ~/public_html that is a symbolic link via NFS to another local host is not
> ! considered local by rdist, so rdist will not copy it to the remote rdist destination).

This example is too specific and inappropriate for a manual page.

-GAWollman

--
Garrett A. Wollman   | O Siem / We are all family / O Siem / We're all the same
wollman@lcs.mit.edu  | O Siem / The fires of freedom 
Opinions not those of| Dance in the burning flame
MIT, LCS, CRS, or NSA|                     - Susan Aglukark and Chad Irschick
Comment 2 Jordan K. Hubbard 1997-11-06 03:40:49 UTC
> >Number:         4954

Ah, OK, there's the PR (sorry, I read your first message before getting
to this one).  If whomever commits it can also change the awkward & to "and",
we'll be fine with this one.  Thanks
Comment 3 Steve Price freebsd_committer freebsd_triage 1997-11-16 13:28:58 UTC
State Changed
From-To: open->closed

Slightly modified patch applied to -current.  Thanks!