UNEXPAND(1P)

πŸ’– UNEXPAND(1P) β€” the POSIX Programmer's Manual era πŸ’–

okay bestie, before we even start: this page is part of the POSIX Programmer's Manual, and the Linux implementation of this interface may differ β€” so if you're on Linux, go peek at the matching Linux manual page for the real deets. It's also possible the interface just... isn't implemented on Linux at all. πŸ™ˆ iykyk.


✨ NAME ✨

unexpand β€” convert spaces to tabs


🌸 SYNOPSIS 🌸

unexpand [-a|-t tablist] [file...]

πŸ¦‹ DESCRIPTION πŸ¦‹

So here's the vibe: unexpand copies files, or standard input, over to standard output, and on the way it converts <blank> characters at the beginning of each line into the maximum number of <tab> characters followed by the minimum number of <space> characters needed to fill the exact same column positions that the original translated <blank> characters were filling. no more, no less. πŸ’…

By default, tabstops are set at every eighth column position.

Every <backspace> gets copied to the output, and it also makes the column position count for tab calculations go down by one. and the count shall never be decremented to a value less than one. periodt.


πŸŽ€ OPTIONS πŸŽ€

unexpand shall conform to the Base Definitions volume of POSIX.1‐2017, Section 12.2, Utility Syntax Guidelines. (yes, that's a real thing, it's the rules of the road for CLI vibes.)

The following options shall be supported:

  • -a β€” on top of translating <blank> characters at the beginning of each line, it also translates all sequences of two or more <blank> characters immediately preceding a tab stop into the maximum number of <tab> characters followed by the minimum number of <space> characters needed to fill the same column positions that the translated <blank> characters originally filled. slay.
  • -t tablist β€” specify the tab stops, bestie. the application shall ensure that the tablist option-argument is a single argument made of either one single positive decimal integer, or multiple positive decimal integers separated by <blank> or <comma> characters, in ascending order.
    • If you give a single number, tabs shall be set tablist column positions apart instead of the default 8.
    • If you give multiple numbers, the tabs shall be set at those specific column positions.

The application shall ensure that each tab-stop position N is an integer value greater than zero, and the list shall be in strictly ascending order. What does that mean? From the start of a line of output, tabbing to position N shall cause the next character output to be in the (N+1)th column position on that line. πŸ€“

When the -t option is not specified, the default shall be the equivalent of specifying -t 8 β€” except for the interaction with -a, described below. so like, careful there.

No <space>-to-<tab> conversions shall occur for characters at positions beyond the last of those specified in a multiple tab-stop list. nope, not happening, that's the boundary.

When -t is specified, the presence or absence of the -a option shall be ignored; conversion shall not be limited to the processing of leading <blank> characters. so -t is the main character here and -a is just standing there. πŸ‘‘


🌈 OPERANDS 🌈

The following operand shall be supported:

  • file β€” a pathname of a text file to be used as input.

⭐ STDIN ⭐

See the INPUT FILES section. (go look, it's right there πŸ’œ)


πŸ“ INPUT FILES πŸ“

The input files shall be text files.


πŸ’œ ENVIRONMENT VARIABLES πŸ’œ

The following environment variables shall affect the execution of unexpand:

  • LANG β€” provides a default value for the internationalization variables that are unset or null. (See the Base Definitions volume of POSIX.1‐2017, Section 8.2, Internationalization Variables for the precedence of internationalization variables used to determine the values of locale categories.)
  • LC_ALL β€” if set to a non-empty string value, overrides the values of all the other internationalization variables. she's the override queen fr fr.
  • LC_CTYPE β€” determines the locale for the interpretation of sequences of bytes of text data as characters (for example, single-byte as opposed to multi-byte characters in arguments and input files), the processing of <tab> and <space> characters, and for the determination of the width in column positions each character would occupy on an output device.
  • LC_MESSAGES β€” determines the locale that should be used to affect the format and contents of diagnostic messages written to standard error.
  • NLSPATH β€” determines the location of message catalogs for the processing of LC_MESSAGES.

🧚 ASYNCHRONOUS EVENTS 🧚

Default. (yes queen, just default πŸ’…)


πŸ”₯ STDOUT πŸ”₯

The standard output shall be equivalent to the input files with the specified <space>-to-<tab> conversions.


πŸ’€ STDERR πŸ’€

The standard error shall be used only for diagnostic messages. nothing else, she's just there to tell you when something's wrong.


🌸 OUTPUT FILES 🌸

None.


🫢 EXTENDED DESCRIPTION 🫢

None.


⭐ EXIT STATUS ⭐

The following exit values shall be returned:

  1. 0 β€” successful completion.
  2. >0 β€” an error occurred.

😭 CONSEQUENCES OF ERRORS 😭

Default.

The following sections are informative.


πŸ’… APPLICATION USAGE πŸ’…

One non-intuitive aspect of unexpand is its restriction to leading <space> characters when neither -a nor -t is specified. literally the thing that trips everyone up, no cap.

Users who always want to convert all <space> characters in a file can easily alias unexpand to use the -a or -t 8 option. problem solved bestie πŸŽ€


πŸŽ€ EXAMPLES πŸŽ€

None.


πŸ‘‘ RATIONALE πŸ‘‘

On several occasions, consideration was given to adding a -t option to the unexpand utility to complement the -t in expand (see expand). The historical intent of unexpand was to translate multiple <blank> characters into tab stops, where tab stops were a multiple of eight column positions on most UNIX systems. An early proposal omitted -t because it seemed outside the scope of the User Portability Utilities option; it was not described in any of the base documents for IEEE Std 1003.2‐1992. However, hard-coding tab stops every eight columns was not suitable for the international community and broke historical precedents for some vendors in the FORTRAN community, so -t was restored in conjunction with the list of valid extension categories considered by the standard developers. Thus, unexpand is now the logical converse of expand. the glow-up arc is real ✨


🌈 FUTURE DIRECTIONS 🌈

None.


πŸ¦‹ SEE ALSO πŸ¦‹

  • expand
  • tabs

The Base Definitions volume of POSIX.1‐2017, Chapter 8, Environment Variables, Section 12.2, Utility Syntax Guidelines


Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


okay that's the whole page, you made it to the end, iconic behavior honestly πŸ†

and that's a wrap, babe β€” this beauty came to you from IEEE/The Open Group, dated 2017, and that's the whole UNEXPAND(1P) situation. go forth and convert those spaces πŸ’…βœ¨

πŸ“¦ where this page comes from