~~DRAFT~~
FIXME

====== Configuration Settings ======

Most configuration options are set up with sane defaults in the file ''/usr/libexec/src2pkg/DEFINES''. The settings listed here may be used globally in ''/etc/src2pkg/src2pkg.conf'' or per-user in ''~/.src2pkg.conf''. For detailed information on syntax and usage, please read the ''/etc/src2pkg/src2pkg.conf'' file.

===== Display =====

==== Display Options ====

^ Setting ^ Default ^ Description ^
| COLOR_PROMPT | "YES" | Color the output from src2pkg |
| QUIET        | "YES" | See full the output from all the commands run |

==== Audio Notification ====

^ Setting ^ Default ^ Description ^
| AUDIO_NOTIFICATION | | Enable audio notification for build completion, failure or cancellation. BEEP: plays a beep; PLAY: plays a recorded sound file; SAY: uses text-to-speech |
| TTS_ENGINE | "flite" | The text-to-speech engine to use. Supports "flite" or "festival" |

===== Security =====

These are only valid if the group 'src2pkg' exists on the system.

^ Setting ^ Default ^ Description ^
| AUTHORIZE_USERS       | "NO" | Allows only users in the src2pkg group to run src2pkg |
| AUTHORIZE_USER_CONF   | "NO" | Disallows the use of personal src2pkg.conf files |
| ALLOW_USER_EXTENSIONS | "NO" | Allows the use of personal extensions in the ~/.src2pkg/extensions directory |

===== Environment =====

==== Directory setup ====

^ Setting ^ Default ^ Description ^
| SOURCES_DIR      | "$CWD" ||
| SRC_BUILDS_DIR   | "/tmp" ||
| PKG_BUILDS_DIR   | "/tmp" ||
| PKG_DEST_DIR     | "/tmp" ||
| BACKUP_DIR       | /tmp   ||
| BACKUPS_SAVE_DIR | /tmp   ||
| PATCHES_DIR      | "$CWD" ||

==== Interactive mode options ====

^ Setting ^ Default ^ Description ^
| INTERACTIVE_MODE        |       | Setting to "ALL" enables all three of the below options |
| QUERY_FOR_EXTRA_CONFIGS | NO   | Setting YES, runs ./configure --help first and waits for input to be set in EXTRA_CONFIGS |
| CONFIRM_BUILD           | NO   | Setting YES, pauses for confirmation to continue building after configuring the source  |
| QUERY_FOR_PKG_DESC      | NO   | Setting YES, pauses and waits for a package description to be entered into PKG_DESC |

==== Source download ====

^ Setting ^ Default ^ Description ^
| DOWNLOADER | wget | Set the program to download files. Currently supported: wget, rsync, curl and lynx|
| DOWNLOADER_OPTIONS | "--tries=3 --timeout=15 -O | Specify the downloader options (wget or aria2c only)|

===== Package build options =====

==== Configure ====

=== Standard ===
^ Setting ^ Default ^ Description ^
| PRE_FIX       | /usr | The installation prefix. Usually specified as --prefix  |
| STD_CONFIGS   |      | Standardized configuration parameters, such as --sysconfdir and --localstatedir  |
| STD_FLAGS     |      | Standard compiler flags. Passed to CFLAGS |
| EXTRA_FLAGS   |      | Extra compiler flags. Also passed to CFLAGS |
| EXTRA_LDFLAGS |      | Linker flags. Passed to LDFLAGS |
| DEFAULT_CONFIG_COMMAND | './configure' | Used for altering the default configure command. For example to something like 'linux32 ./configure' |

=== Logging ===
^ Setting ^ Default ^ Description ^
| LOG_COMMANDS | "YES" | Control whether output logs from configure, make and make install are generated|
| LOG_DIR | "$OBJ_DIR" | Log output directory. Currently supported: $OBJ_DIR, $CWD or an absolute path. |
| EXIT_ON_PATCH_FAILURE | "NO" | Set to "YES" to cause src2pkg to exit when a patch fails |

=== Advanced features ===
^ Setting ^ Default ^ Description ^
| AUTO_CONFIG         | NATIVE | Sets the type of auto-detection for configuration: NATIVE or FOREIGN |
| AUTO_CONFIG_OPTIONS | "sysconfdir localstatedir" |  |
| ADD_EXPLICIT_HOST   | | Setting this to YES, passes ''CFLAGS=-O2 -march=i486 -mtune=i686 ./configure --prefix=/usr --build=i486-slackware-linux --host=i486-slackware-linux'' explicitly to the configure script. |
| ADD_HOST            | | Setting this to YES adds the HOST_OS string to the end of the configure script: ''./configure i486-slackware-linux'' |

==== Make ====

^ Setting ^ Default ^ Description ^
| DEFAULT_MAKE_COMMAND   | 'make' ||
| JOBS | ' ' | Ostensibly used to pass the ''-j'' switch to the make command. |

==== Make install ====

^ Setting ^ Default ^ Description ^
| INSTALL_TYPE | JAIL | The installation method: REAL, DESTDIR, JAIL or UNION |
| UNIONFS_TYPE | unionfs-fuse | When using the UNION install type, what filesystem to use: unionfs-fuse or unionfs |
| FAIL_ON_BAD_DIRS | YES | Abort if a build installs items into an incorrect or potentially dangerous directory  |

==== Package documents ====

^ Setting ^ Default ^ Description ^
| COMPRESS_DOCS | NO | Compress the documents |
| DOC_COMPRESSOR | gzip | Compression method: gzip, bzip2, lzma |
| LINK_LICENSES | NO | If set to YES, common licenses found in the package are moved to a common licence directory and linked to the document directory |
| AUTO_DESKTOP | NO | Attempts to create a *.desktop file when applicable |
^ Setting ^ Default ^ Description ^
| DESC_WRAP_LENGTH | 80 | Characters per line |
| HANDY_RULER_TEXT | "Use this guide to format your text width" ||
| DESC_MAX_LINES   | 11 | Maximum lines in a description file |

==== Extra Files ====

^ Setting ^ Default ^ Description ^
| ADD_SRC2PKG_SCRIPT | "NO" | Setting "YES" adds any build script created in the process to the package |
| SRC2PKG_SCRIPT_DIR | "/usr/src/src2pkg/scripts" ||
| USE_VERSION_NUMBERS    | "NO"   | Use program version numbers when placing scripts outside of the DOC_DIR if set to "YES" |
| LINK_SCRIPT_TO_DOC_DIR | "NO"   | Create a symlink in the DOC_DIR to any script added to the package if set to "YES" |
| EXTENDED_DATABASE      | "YES"  ||
| INCLUDE_DEP_VERSIONS   | "NO"   ||
| INCLUDE_BASE_LIBS      | NO     ||
| ADD_PROVIDES_FILE      | "YES"  ||
| PKG_PROVIDES | 'slack-provides' ||
| ADD_REQUIRED_FILE      | "YES"  ||
| PKG_REQUIRED | 'slack-required' ||

===== Package construction options =====

==== Format ====

^ Setting ^ Default ^ Description ^
| PKG_FORMAT | "tgz" ||
| COMPAT_NAME_SUFFIX | '-compat32' ||
| FHS_POLICY | SLACK ||
| CREATE_MD5_CHECKSUM | "YES" ||

==== Contents ====

^ Setting ^ Default ^ Description ^
| COMPRESS_BINS | NO ||
| BIN_COMPRESSOR | upx ||
| BIN_COMPRESSOR_OPTIONS | "--brute" ||
| COMPRESSION_SIZE_LIMIT | 50 ||


===== Debian .deb Settings =====

^ Setting ^ Default ^ Description ^
| DEB_COMPAT | 2.0 ||
| PKG_COMPRESSOR | gzip ||