dbconfig-generate-include(1)

💖 dbconfig-generate-include(1) 💖

okay bestie, welcome to dbconfig-common's little generator bestie, dbconfig-generate-include 💅 she makes custom-format include files, and honestly? she ate.

✨ 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]

like, yes, that's a lot of brackets. she's flexible, she's versatile, she's that girl. 🦋

✨ DESCRIPTION ✨

dbconfig-generate-include is a whole program whose entire job is generating custom format include files — and inside those files lives all the info you need to connect a program to a database resource. literally her only purpose and she's obsessed with it. 🌸

✨ OPTIONS ✨

okay so here's the full menu, no skips, no cuts, we're listing every single one:

• infile — use the given dbconfig-common config file as input. the main character of the inputs, fr fr. 📥
• outfile — use the given file as output. default? stdout, because she's chill like that. 📤
• -f, --format — use the given output format. default is sh. 🎨
• -o, --options — pass options specific to an output format, as a semicolon separated list. peep the OUTPUT FORMATS/OPTIONS section below for the tea. ☕
• -a, --all — include all the information in the output. this one's the default, bestie. 👑
• -d, --dbname — include the dbname in the output. 🗂️
• -p, --dbpass — include the dbpass in the output. 🤫 (a password! keep it cute and keep it safe)
• -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 comment string that's appropriate for whatever programming language we're in. you can override it with an optional parameter as an arbitrary comment. so like, unset stuff gets politely hidden, not silently yeeted. 💬
• -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. hi bestie, you found it 💖
• -v, --version — output the version and exit. dramatic exit, love that for her. 🚪

🌈 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. the classic. the default. the moment. ✨
• 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_. no cap, that's the whole pattern. 🧚
  • options: template_infile (path to input file containing template)
• cpp — c-style header file, using #define'd constants. 🔥

⚠️ heads up bestie: -o/--options wants that semicolon separated list, and format-specific options live here in this section. don't go inventing format options that aren't listed, ok? iykyk. 💀

and that's the whole page, periodt. 💅 this little icon was written by sean finney back in March 2005, and it ships as part of dbconfig-common, manual section 1. go forth and generate those include files, bestie — you're gonna slay 🎀✨🦋