On Wed, Jun 1, 2016 at 1:53 PM, Jason McIntyre <j...@kerhand.co.uk> wrote:
> - i don;t think it's within ssh(1)'s remit to describe how to quote
>   commands.

While I agree with most of your points, I emphatically disagree with
this line of thought.

More specifically: quoting of ssh commands needs to be documented. If
the description of how to deal with quoting across the multiple sh
contexts which ssh is the prime example of, I think that at the very
least the ssh man page should explicitly refer to some other man page
which covers this issue.

Modularity is important, and it's also important that man pages follow
good structure and leave other topics where they belong. But that's no
excuse for failing to link to relevant documentation, and that's no
excuse for avoiding documenting how to deal with common problems.

More generally, while too much repetition and inappropriate repetition
can be a problem, some repetition is important - especially on
subjects which are highly standardized and difficult to digest in one
sitting.

So I think it is within ssh(1)'s remit to describe how to quote
commands for the target machine, if that can be done concisely. If it
cannot be done concisely, then it belongs in section 5 and ssh(1)
should link to that in the see also section of the page.

Thanks,

-- 
Raul

Reply via email to