Include all utilies within each man page

Explicitly list each util in the help pages to make it more obvious they
exist
This commit is contained in:
Duncan Ferguson 2020-04-18 13:13:47 +01:00
parent 6ec912aac2
commit 7fe7c69769
4 changed files with 35 additions and 2 deletions

View file

@ -1,5 +1,8 @@
Revision history for {{$dist->name}}
4.15 0000-00-00 Duncan Ferguson <duncan_ferguson@user.sf.net>
- Include all utilies within each man page
4.14 2019-08-21 Duncan Ferguson <duncan_ferguson@user.sf.net>
- Include README within the repository, not just created tar.gz files
- Add 'autoquit' setting to 'File' menu (Github issue #114)

10
README
View file

@ -2,7 +2,7 @@ NAME
cssh - Cluster administration tool
VERSION
This documentation is for version: 4.14
This documentation is for version: 4.15
SYNOPSIS
cssh [-a '<command>'] [-K <seconds>] [-q] [-c '<filename>'] [-x <cols>]
@ -12,6 +12,14 @@ SYNOPSIS
[-t '<STRING>'] [-g] [-T '<title>'] [-u] [-?] [-A] [-l '<username>']
[-v]
RELATED
Also see the individual man pages for each of these utilities
ccon - Use 'console' as the communication method
crsh - Use 'rsh' as the communication method
csftp - Use 'sftp' as the communication method
ctel - Use 'telnet' as the communication method
DESCRIPTION
The command opens an administration console and an xterm to all
specified hosts. Any text typed into the administration console is

View file

@ -5,7 +5,7 @@ package App::ClusterSSH;
# ABSTRACT: Cluster administration tool
# ABSTRACT: Cluster administration tool
use version; our $VERSION = version->new('4.14');
use version; our $VERSION = version->new('4.15');
=head1 SYNOPSIS

View file

@ -446,6 +446,28 @@ sub _generate_pod {
}
print $/, $/;
output '=head1 ', $self->loc('RELATED');
output $self->loc(
q{Also see the individual man pages for each of these utilities} );
my %utils = (
ctel => 'telnet',
cssh => 'ssh',
crsh => 'rsh',
csftp => 'sftp',
ccon => 'console',
);
output '=over';
for my $util (sort grep { !/$Script/ } keys %utils) {
output "=item $util - ".$self->loc(
q{Use '[_1]' as the communication method}, $utils{$util}
);
}
output '=back';
output '=head1 ', $self->loc('DESCRIPTION');
output $self->loc(
q{The command opens an administration console and an xterm to all specified hosts. Any text typed into the administration console is replicated to all windows. All windows may also be typed into directly.