Skip to content

Commit

Permalink
Update the README to point to the cheat sheet.
Browse files Browse the repository at this point in the history
  • Loading branch information
mkende committed Oct 2, 2024
1 parent 1ee5b2d commit bf05f9d
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 4 deletions.
2 changes: 2 additions & 0 deletions Makefile.PL
Original file line number Diff line number Diff line change
Expand Up @@ -150,5 +150,7 @@ clean_cheat_sheet:
clean:: clean_cheat_sheet
create_distdir: ptp_cheat_sheet.pdf
MAKE_FRAGMENT
}
8 changes: 7 additions & 1 deletion README.pod
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,16 @@ See examples of B<PTP> in action in the L<documentation|ptp/EXAMPLES>.

=head2 DOCUMENTATION

You can find the documentation for the program itself on L<meta::cpan|ptp>.
You can find the documentation for the program itself on L<meta::cpan|ptp> or on
the L<project wiki|https://github.com/mkende/ptp/wiki/Full-Documentation>.
After the program is installed, you can also get its documentation by running
any of the following commands: B<man ptp>, B<ptp --help> or B<perldoc ptp>.

There is also a quick reference card, available with the B<--cheat> command line
flag or on L<meta::cpan|App::PTP::Cheat_Sheet>, on the
L<project wiki|https://github.com/mkende/ptp/wiki/Cheat-Sheet> or in
L<PDF format|https://metacpan.org/dist/App-PTP/source/ptp_cheat_sheet.pdf>.

The built-in B<--help> rendering will be better if the B<perldoc> program is
installed. It usually comes in a B<perl-doc> package on most systems.

Expand Down
7 changes: 4 additions & 3 deletions lib/App/PTP/Cheat_Sheet.pod
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Pipeline commands are applied, in order, to all the input files.

=item B<-M> I<module>: load the given module

=item B<--sort>, B<--ns> (B<--numeric-sort>), B<--ls>, (B<--locale-sort>),
=item B<--sort>, B<--ns> (B<--numeric-sort>), B<--ls> (B<--locale-sort>),
B<--cs> I<code> (B<--custom-sort>)

=item B<-u> (B<--unique>), B<--gu> (B<--global-unique>)
Expand Down Expand Up @@ -118,11 +118,12 @@ default is C<\n>
=item B<--eol> (B<--preserve-input-separator>), B<--fix-final-separator>

=item B<-0>: set B<--input-separator> to C<NUL> and B<--output-separator> to the
empty string.
empty string

=item B<--00>: set B<--output-separator> to C<NUL>, useful with C<xargs -0>

=item B<-h> (B<--help>), B<--version>: remember to have B<perldoc> installed
=item B<-h> (B<--help>), B<--cheat>, B<--helpshort>, B<--version>: remember to
have B<perldoc> installed

=item B<-d> (B<--debug>), B<--abort>

Expand Down

0 comments on commit bf05f9d

Please sign in to comment.