TT_TYPE_COMP(1)

📦
version 2.5.3 · 2 versions
, in nixos 26.05

💖 NAME 💖

okay so bestie, this is the tt_type_comp page from the (user cmd) manual. Its whole iconic job? Compile ToolTalk otypes and ptypes. 💅

✨ SYNOPSIS ✨

tt_type_comp [-mMs]  [-d db]  [source_file]
tt_type_comp [-r]  [-s]  [-d db]  [type]  [...]
tt_type_comp [-p]  [-O]  [-P]  [-sE]  [-d db]
tt_type_comp [-p]  [-O]  [-P]  [-s]  [source_file]
tt_type_comp [-x]  [-s]  [-o compiled_file]  [source_file]
tt_type_comp [-hv]

🌸 DESCRIPTION 🌸

So the default move for tt_type_comp is: compile types from source form into compiled form, then merge the compiled types into the standard ToolTalk types databases. Before that it preprocesses the source types with cpp(1), periodt. It can optionally write out the compiled types instead of merging them into the standard databases, and it can also remove types from the standard databases or write out the contents of these databases. 💖

tt_type_comp operates in two fundamental modes: XDR and Classing Engine. XDR mode is the default. In XDR mode, the standard databases are simply serialized ToolTalk data structures, and the format of tt_type_comp output files is the same as that of the databases. In Classing Engine mode, the standard databases are in fact the Classing Engine's own databases, and the format of tt_type_comp output files is that expected for input to ce_db_build(1) and ce_db_merge(1). no cap. 🦋

💅 OPTIONS 💅

The following options are available, bestie — every single one:

  • -d db — Specify the database to work on, which must be one of user, system or network. For Classing Engine mode these are defined as:
    • user — $HOME/.cetables/cetables
    • system — /etc/cetables/cetables
    • network — $OPENWINHOME/lib/cetables/cetables

For the XDR format these are defined as:

  • user — $HOME/.tt/types.xdr
  • system — /etc/tt/types.xdr
  • network — $OPENWINHOME/etc/tt/types.xdr

These three databases form a hierarchy in which the definition of a type in the user database overrides the definition in the system database, and so on. For the merge and remove options, the default database is user. For the -p, -O and -P options, the default is all three databases.

  • -E — Use Classing Engine mode, instead of the default XDR mode.
  • -h — Write a help message for invoking tt_type_comp and then exit.
  • -m — Merge types into the specified database, updating any existing type with the new definition given. This is the default action. This action is not supported for Classing Engine mode. The specified database is the first element from the TTPATH environment variable, or $HOME/.tt/types.xdr if TTPATH is NULL or not set. If TTPATH is NULL or not set, it is considered to be:
$HOME/.tt/types.xdr:/etc/tt/types.xdr:/nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/tttypes/types.xdr
  • -M — Merge types into the specified database (see -m), but only if they do not already exist in that database. This action is not supported for Classing Engine mode.
  • -O — Write the names of all otypes read.
  • -p — Write the ToolTalk types read in a source format suitable for recompilation with tt_type_comp.
  • -P — Write the names of all ptypes read.
  • -o compiled_file — Write the compiled types into the specified file, or to standard output if compiled_file is -.
  • -r — Remove the given ptypes or otypes from the specified database, as indicated by the type operands.
  • -s — Silent mode. Write nothing to standard output.
  • -v — Write the version number of tt_type_comp and then exit.
  • -x — Compile source types into a compiled types file, instead of merging them into the standard types databases.

🦋 OPERANDS 🦋

The following operands are supported:

  • source_file — A pathname of a text file containing ToolTalk source code. If source_file is -, standard input is used.
  • type — A name of a type to be removed by the -r option.

🎀 STDIN 🎀

The standard input is used only if a source_file operand is -. 🎀

💜 INPUT FILES 💜

The input file named by source_file is a text file containing ToolTalk source code. 💜

🌈 ENVIRONMENT VARIABLES 🌈

The following environment variables affect the execution of tt_type_comp:

  • CEPATH — In Classing Engine mode, a colon-separated list of directories that tells the Classing Engine where to find the databases that contain (among other things) ToolTalk types. See ce_db_build(1).
  • LANG — Provide a default value for the internationalization variables that are unset or null. If LANG is unset or null, the corresponding value from the implementation-specific default locale will be used. If any of the internationalization variables contains an invalid setting, the utility behaves as if none of the variables had been defined.
  • LC_ALL — If set to a non-empty string value, override the values of all the other internationalization variables.
  • LC_MESSAGES — Determine the locale that is used to affect the format and contents of diagnostic messages written to standard error and informative messages written to standard output.
  • NLSPATH — Determine the location of message catalogues for the processing of LC_MESSAGES.
  • TTPATH — In XDR mode, a colon-separated list of directories that tells the ToolTalk service where to find the ToolTalk types databases. The format of this variable is:
userDir[:systemDir[:networkDir]]

⭐ RESOURCES ⭐

None. Not a single resource, bestie. 🫶

🔥 ASYNCHRONOUS EVENTS 🔥

The tt_type_comp utility takes the standard action for all signals. That's it. 🔥

🍓 STDOUT 🍓

When the -h option is used, tt_type_comp writes to standard output a help message in an unspecified format.

When the -o option is used, tt_type_comp writes to standard output a listing of all otypes read. (yes bestie, lowercase -o right here — that's literally what this page says.)

When the -p option is used, tt_type_comp writes to standard output a listing of all the ToolTalk types read, in a source format suitable for recompilation with tt_type_comp.

When the -P option is used, tt_type_comp writes to standard output a listing of all ptypes read.

When the -v option is used, tt_type_comp writes to standard output a version number in an unspecified format. 🍓

💀 STDERR 💀

Used only for diagnostic messages. 💀

👑 OUTPUT FILES 👑

When the -x or -d user option is used, tt_type_comp writes the compiled types in an unspecified format into a user-specified file. Otherwise, it writes the compiled types into the databases described under -d. 👑

🧚 EXTENDED DESCRIPTION 🧚

None. 🧚

🌟 EXIT STATUS 🌟

The following exit values are returned:

  • 0 — Successful completion.
  • 1 — Usage; tt_type_comp was given invalid command line options.
  • 2 — A syntax error was found in the source types given to tt_type_comp.
  • 3 — System error; tt_type_comp was interrupted by SIGINT, or encountered some system or internal error.

🙈 CONSEQUENCES OF ERRORS 🙈

Default. 🙈

📁 FILES 📁

  • $HOME/.tt/types.xdr — User's ToolTalk types database for XDR mode
  • /etc/tt/types.xdr — System ToolTalk types database for XDR mode
  • /nix/store/6waxpwr8lzfzc9ka48gl7yh60rqvlkdb-cde-2.5.3/appconfig/tttypes/types.xdr — Network ToolTalk types database for XDR mode
  • $OPENWINHOME/etc/tt/types.xdr — Network ToolTalk types database for XDR mode
  • $HOME/.cetables/cetables
  • /etc/cetables/cetables
  • $OPENWINHOME/lib/cetables/cetables

Those last three are the Classing Engine databases containing ToolTalk types for CE mode. See ce_db_build(1). 📁

🫶 APPLICATION USAGE 🫶

None. 🫶

🎉 EXAMPLES 🎉

None. 🎉

🔗 SEE ALSO 🔗

ttsession(1), ce_db_build(1), ce_db_merge(1), cpp(1).

💌 mwah — footer sign-off time: this whole page is the tt_type_comp entry from the (user cmd) manual, and the footer doesn't add a separate date, source, or version line beyond that, bestie. Stay slay. 💖✨

📦 where this page comes from