.TH BIBIMAN.TOML 5 "2024-12-19" "bibiman 0.13.1" "File Formats"
.SH NAME
bibiman.toml \- Configuration file for bibiman
.SH SYNOPSIS
$XDG_CONFIG_HOME/bibiman/bibiman.toml
.br
$HOME/.config/bibiman/bibiman.toml
.SH DESCRIPTION
bibiman.toml is the configuration file for bibiman, a TUI for interacting with
BibLaTeX databases. The file uses TOML format and allows customization of
general behavior, file paths, and color schemes.
.SH FILE LOCATION
The configuration file is searched in the following order:
.RS
.IP 1.
Path specified with \fB--config-file\fR command line option
.IP 2.
$XDG_CONFIG_HOME/bibiman/bibiman.toml
.IP 3.
$HOME/.config/bibiman/bibiman.toml
.RE
If none exists, bibiman will offer to create a default configuration file.
.SH SECTIONS
.SS [general] Section
Contains general configuration options.
.TP
\fBbibfiles\fR = ["/path/to/bibfile", "path/to/dir/with/bibfiles"]
Array of default files/directories to load on startup. Use absolute paths
(~ for HOME works).
.TP
\fBeditor\fR = "vim"
Default editor to use when editing files. Arguments are possible, e.g. "vim -y".
If not set, uses VISUAL and EDITOR environment variables, falling back to "vi".
.TP
\fBpdf_opener\fR = "xdg-open"
Default application to open PDFs/Epubs files.
.TP
\fBurl_opener\fR = "xdg-open"
Default application to open URLs/DOIs.
.TP
\fBfile_prefix\fR = "/some/path/prefix"
Prefix prepended to filepaths from the `file` field in bib entries.
Use absolute paths (~ for HOME works).
.TP
\fBpdf_path\fR = "/path/to/pdf-folder"
Path to folder (with subfolders) containing PDF files with the basename
format "citekey.pdf". Use absolute paths (~ for HOME works).
.TP
\fBnote_path\fR = "path/to/note-files"
Path to folder containing note files with the basename "citekey.extension".
Use absolute paths (~ for HOME works).
.TP
\fBnote_extensions\fR = ["md", "txt"]
Array of valid file extensions for note files.
.TP
\fBfile_symbol\fR = ""
Symbol to show if entry has attached file.
.TP
\fBlink_symbol\fR = ""
Symbol to show if entry has URL/DOI link.
.TP
\fBnote_symbol\fR = ""
Symbol to show if entry has note file.
.TP
\fBcustom_column\fR = "pubtype"
Select a custom column beside standard "author", "title" and "year".
Possible values:
.RS
.IP "journaltitle"
Lists the title of the journal
.IP "organization"
Name of the organization
.IP "institution"
Name of the institution
.IP "series"
Title of the book series
.IP "publisher"
Name of the publisher
.IP "pubtype"
BibLaTex pubtype (article, book, incollection, etc.)
.RE
.SS [colors] Section
Contains color configuration for the TUI. Colors can be set using:
.RS
.IP \(bu
ANSI color names (e.g., "darkgray", "light_black")
.IP \(bu
256-color indices (e.g., "237")
.IP \(bu
HEX codes (e.g., "#3a3a3a")
.RE
.TP
\fBmain_text_color\fR = "250"
Main text color
.TP
\fBhighlight_text_color\fR = "254"
Highlighted text color
.TP
\fBentry_color\fR = "36"
Entry list color
.TP
\fBkeyword_color\fR = "101"
Keyword color
.TP
\fBinfo_color\fR = "99"
Info window color
.TP
\fBconfirm_color\fR = "47"
Confirmation message color
.TP
\fBwarn_color\fR = "124"
Warning message color
.TP
\fBbar_bg_color\fR = "234"
Status bar background color
.TP
\fBpopup_fg_color\fR = "43"
Popup foreground color
.TP
\fBpopup_bg_color\fR = "234"
Popup background color
.TP
\fBselected_row_bg_color\fR = "237"
Selected row background color
.TP
\fBnote_color\fR = "123"
Note file color
.TP
\fBfile_color\fR = "209"
PDF file color
.TP
\fBlink_color\fR = "27"
URL/DOI link color
.TP
\fBauthor_color\fR = "38"
Author column color
.TP
\fBtitle_color\fR = "37"
Title column color
.TP
\fByear_color\fR = "135"
Year column color
.SH EXAMPLES
A minimal configuration file:
.sp
.nf
.RS
[general]
bibfiles = ["~/Documents/biblio/main.bib"]
editor = "nvim"
pdf_opener = "zathura"
url_opener = "firefox"
.RE
.fi
.sp
A full configuration with custom colors:
.sp
.nf
.RS
[general]
bibfiles = ["~/papers/bibliography", "~/refs/important.bib"]
editor = "emacs -nw"
pdf_opener = "mupdf"
url_opener = "qutebrowser"
file_prefix = "~/Documents/literature"
pdf_path = "~/papers/pdfs"
note_path = "~/papers/notes"
note_extensions = ["md", "txt", "org"]
file_symbol = ""
link_symbol = ""
note_symbol = ""
custom_column = "journaltitle"

[colors]
main_text_color = "#ffffff"
highlight_text_color = "#ffff00"
entry_color = "cyan"
selected_row_bg_color = "#444444"
.RE
.fi
.SH "SEE ALSO"
.BR bibiman (1)
.SH AUTHOR
Lukeflo <lukeflo_git@posteo.de>