---
name: "dbconfig-generate-include"
section: "1"
platform: "linux"
package: "dbconfig-common"
version: "2.0.25"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/dbconfig-generate-include"
---

# dbconfig-generate-include(1)

generate custom format db include files

## NAME

dbconfig-generate-include - generate custom format db include files

## SYNOPSIS

**dbconfig-generate-include \[-hv\] \[-f format\] \[-o options\] \[-a\] \[-d\[varname\]\] \[-u\[varname\]\] \[-p\[varname\]\] \[-s\[varname\]\] \[-P\[varname\]\] \[-t\[varname\]\] \[-C\[commentstr\]\] \[-O owner\[:group\]\] \[-m mode\] \[-U\] infile \[outfile\]**\

## DESCRIPTION

**dbconfig-generate-include** is a program to generate custom format include files containing the information necessary to connect a program to a database resource.

## OPTIONS

- infile

  use the given dbconfig-common config file as input

- outfile

  use the given file as output (default: stdout)

- **-f**\|--format

  use the given output format (default: sh)

- **-o**\|--options

  pass options specific to an output format in a semicolon separated list. see OUTPUT FORMATS/OPTIONS for more information.

- **-a**\|--all

  include all information in output (default)

- **-d**\|--dbname

  include the dbname in the output

- **-p**\|--dbpass

  include the dbpass in the output

- **-s**\|--dbserver

  include the dbserver in the output

- **-P**\|--dbport

  include the dbport in the output

- **-u**\|--dbuser

  include the dbuser in the output

- **-t**\|--dbtype

  include the dbtype in the output

- **-C**\|--comment

  "comment out" any unset variables, using a string appropriate comment string for the programming language in question.  can be overridden with an optional parameter as an arbitrary comment.

- **-O**\|--owner

  set the owner:group of the output file

- **-m**\|--mode

  set the permissions on the output file

- **-U**\|--ucf

  register the outputfile with ucf

- **-h**\|--help

  display this helpful message

- **-v**\|--version

  output the version and exit

## OUTPUT FORMATS/OPTIONS

format is one of a list of include-file style formats for various programming languages.  the current list includes:

- sh

  /bin/sh style include file.

- perl

  perl parseable include file.

- php

  php parseable include file.

- template

  a file which contains a series of fields to be replaced with actual values.  all substitutable fields consist of the underlying dbc\_ variable name capitalized and surrounded with underscores.  for example: \_DBC\_DBUSER\_.  **options:**  template\_infile (path to input file containing template)

- cpp

  c-style header file, using #define'd constants.