GENCAT(1P)

๐Ÿ’… GENCAT(1P) โ€” generate a formatted message catalog โœจ

okay bestie, listen up ๐Ÿ’– this one's from the POSIX Programmer's Manual, and before we even get into it, here's the tea:

โš ๏ธ This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the corresponding Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux. ๐Ÿซ 

โœจ NAME โœจ

gencat โ€” generate a formatted message catalog


๐ŸŒธ SYNOPSIS ๐ŸŒธ

gencat catfile msgfile...

๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

so the gencat utility shall merge the message text source file msgfile into a formatted message catalog catfile. no cap.

The file catfile shall be created if it does not already exist. And if catfile does already exist, its messages shall be included in the new catfile โ€” like, nothing gets ghosted ๐Ÿ‘ป. But if set and message numbers collide, the new message text defined in msgfile shall replace the old message text currently contained in catfile. new text wins, periodt ๐Ÿ’…


๐ŸŽ€ OPTIONS ๐ŸŽ€

None. literally none. the options are not giving anything. moving on ๐Ÿ˜Œ


๐Ÿ’– OPERANDS ๐Ÿ’–

The following operands shall be supported:

  • catfile โ€” A pathname of the formatted message catalog. If '-' is specified, standard output shall be used. The format of the message catalog produced is unspecified. (iykyk ๐Ÿซถ)
  • msgfile โ€” A pathname of a message text source file. If '-' is specified for an instance of msgfile, standard input shall be used. The format of message text source files is defined in the EXTENDED DESCRIPTION section. keep scrolling bestie ๐Ÿ‘‡

โญ STDIN โญ

The standard input shall not be used unless a msgfile operand is specified as '-'. so don't @ it otherwise ๐Ÿ™ˆ


๐ŸŒˆ INPUT FILES ๐ŸŒˆ

The input files shall be text files.


๐Ÿ‘‘ ENVIRONMENT VARIABLES ๐Ÿ‘‘

The following environment variables shall affect the execution of gencat:

  • LANG โ€” Provide 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, override the values of all the other internationalization variables. she's the main character, she overrides everyone ๐Ÿ’…
  • LC_CTYPE โ€” Determine 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).
  • LC_MESSAGES โ€” Determine the locale that should be used to affect the format and contents of diagnostic messages written to standard error.
  • NLSPATH โ€” Determine the location of message catalogs for the processing of LC_MESSAGES.

๐Ÿ’œ ASYNCHRONOUS EVENTS ๐Ÿ’œ

Default. she's chill like that ๐Ÿ˜Œ


๐Ÿ”ฅ STDOUT ๐Ÿ”ฅ

The standard output shall not be used unless the catfile operand is specified as '-'.


๐Ÿ“ STDERR ๐Ÿ“

The standard error shall be used only for diagnostic messages. just the diagnostics, nothing else, no drama ๐Ÿซถ


๐Ÿงš OUTPUT FILES ๐Ÿงš

None.


๐ŸŒŸ EXTENDED DESCRIPTION ๐ŸŒŸ

okay this is the big one, stay with me bestie, we're going deep ๐ŸŒŠ

The content of a message text file shall be in the format defined as follows. Note that the fields of a message text source line are separated by a single <blank> character. Any other <blank> characters are considered to be part of the subsequent field. so like, one space is a divider, the rest is just vibes and content โœจ

  • $set n comment โ€” This line specifies the set identifier of the following messages until the next $set or end-of-file appears. The n denotes the set identifier, which is defined as a number in the range [1, {NL_SETMAX}] (see the <limits.h> header defined in the Base Definitions volume of POSIX.1โ€2017). The application shall ensure that set identifiers are presented in ascending order within a single source file, but need not be contiguous. Any string following the set identifier shall be treated as a comment. If no $set directive is specified in a message text source file, all messages shall be located in an implementation-defined default message set NL_SETD (see the <nl_types.h> header defined in the Base Definitions volume of POSIX.1โ€2017).
  • $delset n comment โ€” This line deletes message set n from an existing message catalog. The n denotes the set number [1, {NL_SETMAX}]. Any string following the set number shall be treated as a comment. bye set, we hardly knew ye ๐Ÿ’€
  • $ comment โ€” A line beginning with '$' followed by a <blank> shall be treated as a comment.
  • m message-text โ€” The m denotes the message identifier, which is defined as a number in the range [1, {NL_MSGMAX}] (see the <limits.h> header). The message-text shall be stored in the message catalog with the set identifier specified by the last $set directive, and with message identifier m. If the message-text is empty, and a <blank> field separator is present, an empty string shall be stored in the message catalog. If a message source line has a message number, but neither a field separator nor message-text, the existing message with that number (if any) shall be deleted from the catalog. The application shall ensure that message identifiers are in ascending order within a single set, but need not be contiguous. The application shall ensure that the length of message-text is in the range [0, {NL_TEXTMAX}] (see the <limits.h> header).
  • $quote n โ€” This line specifies an optional quote character c, which can be used to surround message-text so that trailing <space> characters or null (empty) messages are visible in a message source line. By default, or if an empty $quote directive is supplied, no quoting of message-text shall be recognized.

Empty lines in a message text source file shall be ignored. The effects of lines starting with any character other than those defined above are implementation-defined. ๐Ÿ‘€

Text strings can contain the special characters and escape sequences defined in the following table:

  • <newline> โ€” symbol NL(LF) โ€” sequence \n
  • Horizontal-tab โ€” symbol HT โ€” sequence \t
  • <vertical-tab> โ€” symbol VT โ€” sequence \v
  • <backspace> โ€” symbol BS โ€” sequence \b
  • <carriage-return> โ€” symbol CR โ€” sequence \r
  • <form-feed> โ€” symbol FF โ€” sequence \f
  • Backslash โ€” symbol \ โ€” sequence \\
  • Bit pattern โ€” symbol ddd โ€” sequence \ddd

The escape sequence "\ddd" consists of <backslash> followed by one, two, or three octal digits, which shall be taken to specify the value of the desired character. If the character following a <backslash> is not one of those specified, the <backslash> shall be ignored.

A <backslash> followed by a <newline> is also used to continue a string on the following line. Thus, the following two lines describe a single message string:

1 This line continues \
to the next line

which shall be equivalent to:

1 This line continues to the next line

like, same message, just wrapped for the aesthetic ๐Ÿ’…


๐ŸŽ‰ 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. (so like, they're the bonus content, not the rules ๐Ÿ“š)


๐ŸŒธ APPLICATION USAGE ๐ŸŒธ

Message catalogs produced by gencat are binary encoded, meaning that their portability cannot be guaranteed between different types of machine. Thus, just as C programs need to be recompiled for each type of machine, so message catalogs must be recreated via gencat. no cap, don't try to copy them around, they will not slay on a different arch ๐Ÿ˜ญ


โœจ EXAMPLES โœจ

None. (bestie really said "figure it out" ๐Ÿ˜ญ)


๐Ÿ’ญ RATIONALE ๐Ÿ’ญ

None.


๐Ÿ”ฎ FUTURE DIRECTIONS ๐Ÿ”ฎ

None.


๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

  • iconv
  • The Base Definitions volume of POSIX.1โ€2017, Chapter 8, Environment Variables, <limits.h>, <nl_types.h>

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 .


and that's the whole page bestie ๐Ÿซถ this one's brought to you by IEEE/The Open Group, 2017, filed under GENCAT(1P). go forth and generate those catalogs, you absolute icon ๐Ÿ‘‘โœจ

๐Ÿ“ฆ where this page comes from