Manual portconfig

Posted on 2022-01-06 - Updated on 2025-01-07

portconfig is an utility for the FreeBSD Operating System to set up ports options. This is the manual, please refer to the README for more info.

PORTCONFIG(1)           FreeBSD General Commands Manual          PORTCONFIG(1)

NAME
     portconfig - port options

SYNOPSIS
     portconfig [-h | -v]

DESCRIPTION
     The portconfig utility provides a TUI to customize the options to build a
     port.  The following options are available:

     -h      Display options, a short description and exit.

     -v      Show version and exit.

     The following user interface features are available:

     F1 key  General PORTS usage.

     Help button
             Specific port help, if pkg-help exists.

     Space key
             Select/deselect an option.

ENVIRONMENT
     The following environment variables can customize portconfig:

     NO_COLOR=<something>
             Disable colors if present and not an empty string (regardless of
             its value).

     PORTCONFIG_ALIGNCENTER=YES
             Align options to center, default left.

     PORTCONFIG_ASCIILINES=YES
             Ascii characters to draw lines.

     PORTCONFIG_CLOCALE=YES
             Force using only 8 bit characters, useful in non-utf-8
             environments.

     PORTCONFIG_FULLSCREEN=YES
             Fullscreen mode.

     PORTCONFIG_HEIGHT=<height>
             Fixed height, default autosize.

     PORTCONFIG_MINHEIGHT=<height>
             Minimum height, takes effect only with autosize.

     PORTCONFIG_MINWIDTH=<width>
             Minimum width, takes effect only with autosize.

     PORTCONFIG_NOLINES=YES
             Do not draw lines.

     PORTCONFIG_NOSHADOW=YES
             Disable dialog shadow.

     PORTCONFIG_THEMEFILE=<file>
             Load theme file.

     PORTCONFIG_WIDTH=<width>
             Fixed width, default autosize.

     See EXAMPLES section below.

   Compatibility
     The following environment variables are available for compatibility:
           D4PALIGNCENTER        PORTCONFIG_ALIGNCENTER
           D4PASCIILINES         PORTCONFIG_ASCIILINES
           D4PFULLSCREEN         PORTCONFIG_FULLSCREEN
           D4PHEIGHT             PORTCONFIG_HEIGHT
           D4PMINHEIGHT          PORTCONFIG_MINHEIGHT
           D4PWIDTH              PORTCONFIG_WIDTH

FILES
     The theme file /usr/local/etc/portconfig/theme.conf is read on startup if
     exists.

     Template theme files are installed in /usr/local/etc/portconfig/.

     To create a new theme file run:
           /usr/local/bin/bsddialog --save-theme mytheme.conf --infobox \
           "Saving theme..." 0 0

THEME
     The theme configuration in order of priority is as follows:

     Check Terminal Colors.
             portconfig checks if the environments has colors, otherwise sets
             black and white theme.

     env NO_COLOR=<something>
             If present and not an empty string sets black and white theme.

     env PORTCONFIG_THEMEFILE=<file>
             if <file> exists and is well-formed its theme is set.  Otherwise
             the default theme is set.

     /usr/local/etc/portconfig/theme.conf
             if the file exists and is well-formed its theme is set.
             Otherwise the default theme is set.

     Otherwise
             Default theme file set.

     These options are mutually exclusive.

EXIT STATUS
     The portconfig utility exits 0 on success, and >0 if an error occurs.

EXAMPLES
     Examples refer to a standard installation with sh(1) and tcsh(1) calling
     portconfig implicitly via "make config" in /usr/ports/<category>/<port>.

     To run portconfig in black and white:
           env NO_COLOR=YES make config

     Add the following line to make.conf(5) to make this setting permanent:
           export NO_COLOR=YES

SEE ALSO
     portoptscli(1), ports(7)

AUTHORS
     The portconfig utility was written by Alfonso Sabato Siciliano
     <asiciliano@FreeBSD.org>.

THANKS TO
     Baptiste Daroussin <bapt@FreeBSD.org> for suggestions, help, and testing.

FreeBSD 15.0-CURRENT            January 7, 2025           FreeBSD 15.0-CURRENT