{
    "content": [
        {
            "type": "text",
            "text": "# IO::Stty (perldoc)\n\n## NAME\n\nIO::Stty - Change and print terminal line settings\n\n## SYNOPSIS\n\n# calling the script directly\nstty.pl [setting...]\nstty.pl {-a,-g,-v,--version}\n# Calling Stty module\nuse IO::Stty;\nIO::Stty::stty(\\*TTYHANDLE, @modes);\nuse IO::Stty;\n$oldmode=IO::Stty::stty(\\*STDIN,'-g');\n# Turn off echoing.\nIO::Stty::stty(\\*STDIN,'-echo');\n# Do whatever.. grab input maybe?\n$readpassword = <>;\n# Now restore the old mode.\nIO::Stty::stty(\\*STDIN,$oldmode);\n# What settings do we have anyway?\nprint IO::Stty::stty(\\*STDIN,'-a');\n\n## DESCRIPTION\n\nThis is the PERL POSIX compliant stty.\n\n## Sections\n\n- **NAME**\n- **SYNOPSIS**\n- **DESCRIPTION**\n- **INTRO** (8 subsections)\n- **Direct Subroutines** (2 subsections)\n- **AUTHOR**\n- **BUGS**\n- **ACKNOWLEDGEMENTS**\n\nUse structuredContent.sections for detailed options, examples, and full documentation.\n"
        }
    ],
    "structuredContent": {
        "command": "IO::Stty",
        "section": "",
        "mode": "perldoc",
        "summary": "IO::Stty - Change and print terminal line settings",
        "synopsis": "# calling the script directly\nstty.pl [setting...]\nstty.pl {-a,-g,-v,--version}\n# Calling Stty module\nuse IO::Stty;\nIO::Stty::stty(\\*TTYHANDLE, @modes);\nuse IO::Stty;\n$oldmode=IO::Stty::stty(\\*STDIN,'-g');\n# Turn off echoing.\nIO::Stty::stty(\\*STDIN,'-echo');\n# Do whatever.. grab input maybe?\n$readpassword = <>;\n# Now restore the old mode.\nIO::Stty::stty(\\*STDIN,$oldmode);\n# What settings do we have anyway?\nprint IO::Stty::stty(\\*STDIN,'-a');",
        "tldr_summary": null,
        "tldr_examples": [],
        "tldr_source": null,
        "flags": [],
        "examples": [],
        "see_also": [],
        "section_outline": [
            {
                "name": "NAME",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "SYNOPSIS",
                "lines": 23,
                "subsections": []
            },
            {
                "name": "DESCRIPTION",
                "lines": 2,
                "subsections": []
            },
            {
                "name": "INTRO",
                "lines": 9,
                "subsections": [
                    {
                        "name": "Control settings",
                        "lines": 21
                    },
                    {
                        "name": "Input settings",
                        "lines": 34
                    },
                    {
                        "name": "Output settings",
                        "lines": 3
                    },
                    {
                        "name": "Local settings",
                        "lines": 26
                    },
                    {
                        "name": "Combination settings",
                        "lines": 39
                    },
                    {
                        "name": "Special characters",
                        "lines": 31
                    },
                    {
                        "name": "Special settings",
                        "lines": 18
                    },
                    {
                        "name": "-v,--version",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "Direct Subroutines",
                "lines": 1,
                "subsections": [
                    {
                        "name": "stty",
                        "lines": 10
                    },
                    {
                        "name": "show_me_the_crap",
                        "lines": 2
                    }
                ]
            },
            {
                "name": "AUTHOR",
                "lines": 4,
                "subsections": []
            },
            {
                "name": "BUGS",
                "lines": 7,
                "subsections": []
            },
            {
                "name": "ACKNOWLEDGEMENTS",
                "lines": 8,
                "subsections": []
            }
        ],
        "sections": {
            "NAME": {
                "content": "IO::Stty - Change and print terminal line settings\n",
                "subsections": []
            },
            "SYNOPSIS": {
                "content": "# calling the script directly\nstty.pl [setting...]\nstty.pl {-a,-g,-v,--version}\n\n# Calling Stty module\nuse IO::Stty;\nIO::Stty::stty(\\*TTYHANDLE, @modes);\n\nuse IO::Stty;\n$oldmode=IO::Stty::stty(\\*STDIN,'-g');\n\n# Turn off echoing.\nIO::Stty::stty(\\*STDIN,'-echo');\n\n# Do whatever.. grab input maybe?\n$readpassword = <>;\n\n# Now restore the old mode.\nIO::Stty::stty(\\*STDIN,$oldmode);\n\n# What settings do we have anyway?\nprint IO::Stty::stty(\\*STDIN,'-a');\n",
                "subsections": []
            },
            "DESCRIPTION": {
                "content": "This is the PERL POSIX compliant stty.\n",
                "subsections": []
            },
            "INTRO": {
                "content": "This has not been tailored to the IO::File stuff but will work with it as indicated. Before you\ngo futzing with term parameters it's a good idea to grab the current settings and restore them\nwhen you finish.\n\nstty accepts the following non-option arguments that change aspects of the terminal line\noperation. A `[-]' before a capability means that it can be turned off by preceding it with a\n`-'.\n\nstty parameters",
                "subsections": [
                    {
                        "name": "Control settings",
                        "content": "[-]parenb\nGenerate parity bit in output and expect parity bit in input.\n\n[-]parodd\nSet odd parity (even with `-').\n\ncs5 cs6 cs7 cs8\nSet character size to 5, 6, 7, or 8 bits.\n\n[-]hupcl [-]hup\nSend a hangup signal when the last process closes the tty.\n\n[-]cstopb\nUse two stop bits per character (one with `-').\n\n[-]cread\nAllow input to be received.\n\n[-]clocal\nDisable modem control signals.\n"
                    },
                    {
                        "name": "Input settings",
                        "content": "[-]ignbrk\nIgnore break characters.\n\n[-]brkint\nBreaks cause an interrupt signal.\n\n[-]ignpar\nIgnore characters with parity errors.\n\n[-]parmrk\nMark parity errors (with a 255-0-character sequence).\n\n[-]inpck\nEnable input parity checking.\n\n[-]istrip\nClear high (8th) bit of input characters.\n\n[-]inlcr\nTranslate newline to carriage return.\n\n[-]igncr\nIgnore carriage return.\n\n[-]icrnl\nTranslate carriage return to newline.\n\n[-]ixon\nEnable XON/XOFF flow control.\n\n[-]ixoff\nEnable sending of stop character when the system input buffer is almost full, and start\ncharacter when it becomes almost empty again.\n"
                    },
                    {
                        "name": "Output settings",
                        "content": "[-]opost\nPostprocess output.\n"
                    },
                    {
                        "name": "Local settings",
                        "content": "[-]isig\nEnable interrupt, quit, and suspend special characters.\n\n[-]icanon\nEnable erase, kill, werase, and rprnt special characters.\n\n[-]echo\nEcho input characters.\n\n[-]echoe, [-]crterase\nEcho erase characters as backspace-space-backspace.\n\n[-]echok\nEcho a newline after a kill character.\n\n[-]echonl\nEcho newline even if not echoing other characters.\n\n[-]noflsh\nDisable flushing after interrupt and quit special characters.\n\n* Though this claims non-posixhood it is supported by the perl POSIX.pm.\n\n[-]tostop (np)\nStop background jobs that try to write to the terminal.\n"
                    },
                    {
                        "name": "Combination settings",
                        "content": "ek  Reset the erase and kill special characters to their default values.\n\nsane\nSame as:\n\ncread -ignbrk brkint -inlcr -igncr icrnl -ixoff opost\nisig icanon echo echoe echok -echonl -noflsh -tostop\n\nalso sets all special characters to their default values.\n\n[-]cooked\nSame as:\n\nbrkint ignpar istrip icrnl ixon opost isig icanon\n\nplus sets the eof and eol characters to their default values if they are the same as the min\nand time characters. With `-', same as raw.\n\n[-]raw\nSame as:\n\n-ignbrk -brkint -ignpar -parmrk -inpck -istrip -inlcr -igncr\n-icrnl -ixon -ixoff -opost -isig -icanon min 1 time 0\n\nWith `-', same as cooked.\n\n[-]pass8\nSame as:\n\n-parenb -istrip cs8\n\nWith `-', same as parenb istrip cs7.\n\ndec Same as:\n\nechoe echoctl echoke -ixany\n\nAlso sets the interrupt special character to Ctrl-C, erase to Del, and kill to Ctrl-U.\n"
                    },
                    {
                        "name": "Special characters",
                        "content": "The special characters' default values vary from system to system. They are set with the syntax\n`name value', where the names are listed below and the value can be given either literally, in\nhat notation (`^c'), or as an integer which may start with `0x' to indicate hexadecimal, `0' to\nindicate octal, or any other digit to indicate decimal. Giving a value of `^-' or `undef'\ndisables that special character.\n\nintr\nSend an interrupt signal.\n\nquit\nSend a quit signal.\n\nerase\nErase the last character typed.\n\nkill\nErase the current line.\n\neof Send an end of file (terminate the input).\n\neol End the line.\n\nstart\nRestart the output after stopping it.\n\nstop\nStop the output.\n\nsusp\nSend a terminal stop signal.\n"
                    },
                    {
                        "name": "Special settings",
                        "content": "min N\nSet the minimum number of characters that will satisfy a read until the time value has\nexpired, when <E>-icanon<E> is set.\n\ntime N\nSet the number of tenths of a second before reads time out if the min number of characters\nhave not been read, when -icanon is set.\n\nN   Set the input and output speeds to N. N can be one of: 0 50 75 110 134 134.5 150 200 300 600\n1200 1800 2400 4800 9600 19200 38400 exta extb. exta is the same as 19200; extb is the same\nas 38400. 0 hangs up the line if -clocal is set.\n\nOPTIONS\n-a  Print all current settings in human-readable form.\n\n-g  Print all current settings in a form that can be used as an argument to another stty command\nto restore the current settings.\n"
                    },
                    {
                        "name": "-v,--version",
                        "content": "Print version info.\n"
                    }
                ]
            },
            "Direct Subroutines": {
                "content": "",
                "subsections": [
                    {
                        "name": "stty",
                        "content": "IO::Stty::stty(\\*STDIN, @params);\n\nFrom comments:\n\nI'm not feeling very inspired about this. Terminal parameters are obscure\nand boring. Basically what this will do is get the current setting,\ntake the parameters, modify the setting and write it back. Zzzz.\nThis is not especially efficent and probably not too fast. Assuming the POSIX\nspec has been implemented properly it should mostly work.\n"
                    },
                    {
                        "name": "show_me_the_crap",
                        "content": "Needs documentation\n"
                    }
                ]
            },
            "AUTHOR": {
                "content": "Austin Schutz <auschutz@cpan.org> (Initial version and maintenance)\n\nTodd Rinaldo <toddr@cpan.org> (Maintenance)\n",
                "subsections": []
            },
            "BUGS": {
                "content": "This is use at your own risk software. Do anything you want with it except blame me for it\nblowing up your machine because it's full of bugs.\n\nSee above for what functions are supported. It's mostly standard POSIX stuff. If any of the\nsettings are wrong and you actually know what some of these extremely arcane settings (like what\n'sane' should be in POSIX land) really should be, please open an RT ticket.\n",
                "subsections": []
            },
            "ACKNOWLEDGEMENTS": {
                "content": "None\n\nCOPYRIGHT & LICENSE\nCopyright 1997 Austin Schutz, all rights reserved.\n\nThis program is free software; you can redistribute it and/or modify it under the same terms as\nPerl itself.\n",
                "subsections": []
            }
        }
    }
}