Skip to content

docs: modernize POD references and add SEE ALSO #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
toddr-bot wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

docs: modernize POD references and add SEE ALSO #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ IO::Stty - Change and print terminal line settings

# DESCRIPTION

This is the PERL POSIX compliant stty.
This is a Perl POSIX compliant stty.

# INTRO

Expand Down Expand Up @@ -391,6 +391,14 @@ Linux and 255 on macOS/BSD).

This is the back-end for `stty(\*FH, '-a')`.

# SEE ALSO

[stty(1)](http://man.he.net/man1/stty) - the Unix command-line equivalent.

[POSIX](https://metacpan.org/pod/POSIX) - provides the underlying `Termios` interface used by this module.

[Term::ReadKey](https://metacpan.org/pod/Term%3A%3AReadKey) - another approach to terminal mode manipulation.

# AUTHOR

Austin Schutz <auschutz@cpan.org> (Initial version and maintenance)
Expand All @@ -405,7 +413,8 @@ blame me for it blowing up your machine because it's full of bugs.
See above for what functions are supported. It's mostly standard POSIX
stuff. If any of the settings are wrong and you actually know what some of
these extremely arcane settings (like what 'sane' should be in POSIX land)
really should be, please open an RT ticket.
really should be, please open an issue at
[https://github.com/cpan-authors/IO-Stty/issues](https://github.com/cpan-authors/IO-Stty/issues).

# ACKNOWLEDGEMENTS

Expand Down
13 changes: 11 additions & 2 deletions lib/IO/Stty.pm
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ IO::Stty - Change and print terminal line settings

=head1 DESCRIPTION

This is the PERL POSIX compliant stty.
This is a Perl POSIX compliant stty.

=head1 INTRO

Expand Down Expand Up @@ -945,6 +945,14 @@ sub show_me_the_crap {

=back

=head1 SEE ALSO

L<stty(1)> - the Unix command-line equivalent.

L<POSIX> - provides the underlying C<Termios> interface used by this module.

L<Term::ReadKey> - another approach to terminal mode manipulation.

=head1 AUTHOR

Austin Schutz <auschutz@cpan.org> (Initial version and maintenance)
Expand All @@ -959,7 +967,8 @@ blame me for it blowing up your machine because it's full of bugs.
See above for what functions are supported. It's mostly standard POSIX
stuff. If any of the settings are wrong and you actually know what some of
these extremely arcane settings (like what 'sane' should be in POSIX land)
really should be, please open an RT ticket.
really should be, please open an issue at
L<https://github.com/cpan-authors/IO-Stty/issues>.

=head1 ACKNOWLEDGEMENTS

Expand Down
Loading