Package: pnu-echobox
Installationpip installpnu-echoboxECHOBOX(1)NAMEechobox - write arguments in a box to the standard outputSYNOPSISechobox[-a|--align name]
[-b|--basic-char char]
[-f|--fill-char char]
[-i|--inter-lines number]
[-l|--lead-lines number]
[-S|--style name]
[-s|--spaces number]
[-t|--trail-lines number]
[--debug]
[--help|-?]
[--version]
[--]
[string ...]DESCRIPTIONTheechoboxutility writes any specified operands, separated by single blank (' ') characters, in a box, to the standard output.
The "\n" substring is used to split the concatenated operands into multiple lines.If there are no arguments provided on the command line, standard input is read
(until a Control-D (Unix) or Control-Z (Windows) character is sent).OPTIONSOptionsUse-a|--align nameSets the alignment to use. Possible values: left (default), center, middle, right.-b|--basic-char charSets the character to use with the basic style. Default value: '#'.-f|--fill-char charSets the character to use to fill the box. Default value: ' '.-i|--inter-lines numberSets the number of lines separating the text from the box on the top and bottom sides. Default value: 1.-l|--lead-lines numberSets the number of blank lines preceding the box. Default value: 0.-S|--style nameSets the style to use. Possible values: basic (default), ascii, single, curved, hatched, double, block.-s|--spaces numberSets the number of spaces separating the text from the box on the left and right sides. Default value: 3.-t|--trail-lines numberSets the number of blank lines following the box. Default value: 1.--debugEnable debug level messages.--help|-?Print usage and a short help message and exit.--versionPrint version and exit.--Options processing terminator. Contrarily to theecho(1)command, it is recognized as such.ENVIRONMENTEnvironment variables are processed first and thus overridden by command line options.VariableUseECHOBOX_STYLESets the style to use.ECHOBOX_ALIGNSets the alignment to use.ECHOBOX_BASIC_CHARSets the character to use with the basic style.ECHOBOX_FILL_CHARSets the character to use to fill the box.ECHOBOX_SPACESSets the number of spaces separating the text from the box on the left and right sides.ECHOBOX_INTER_LINESSets the number of lines separating the text from the box on the top and bottom sides.ECHOBOX_LEAD_LINESSets the number of blank lines preceding the box.ECHOBOX_TRAIL_LINESSets the number of blank lines following the box.ECHOBOX_DEBUGEnable debug level messages.COLUMNSDefines the number of columns in the terminal window. This variable is sometimes provided by theBashshell and some others, but not necessarily exported. It's used for center and right alignments. Default value: 80.EXIT STATUSTheechoboxutility exits 0 on success, and >0 if an error occurs.SEE ALSOdialog(1),fortune(6)https://en.wikipedia.org/wiki/Box-drawing_characterhttps://unicode-table.com/fr/#box-drawingSTANDARDSTheechoboxcommand is not a standardUNIX/POSIXcommand.It tries to follow thePEP 8style guide forPythoncode.PORTABILITYTested OK under Windows, though some of the styles are not available
(thehatched and curved Unicode charactersare not fully recognized in the cmd.exe and PowerShell command prompts).HISTORYTheechoboxcommand was created as an example for thePNU project,
demonstrating how to process the environment and the command line, and use thePython logging module.It's also used as a filter forfortune(6)output,
in order to introduce someboxology.LICENSEThis utility is available under the3-clause BSD license.AUTHORSHubert TournierCAVEATSSpecifying basic or fillUnicodecharacters is not currently possible with the environment and command line options.Display will overflow if your text is wider than your console.