add man pages & justfile to organiseman

1 files changed, 197 insertions, 0 deletions

diff --git a/man/bibiman.1 b/man/bibiman.1
new file mode 100644
index 0000000..dce1b32
--- /dev/null
+++ b/man/bibiman.1
@@ -0,0 +1,197 @@
+.TH BIBIMAN 1 "2024-12-19" "bibiman 0.13.1" "User Commands"
+.SH NAME
+bibiman \- TUI for interacting with BibLaTeX databases
+.SH SYNOPSIS
+.B bibiman
+[\fIOPTIONS\fR] [\fIFILE\fR]...
+.br
+.B bibiman
+[\fIOPTIONS\fR] [\fIDIRECTORY\fR]...
+.SH DESCRIPTION
+bibiman is a simple terminal user interface for handling your BibLaTeX
+database as part of a terminal-based scientific workflow. It provides a
+TUI for browsing, searching, editing, and managing bibliography entries
+with Vim-like keybindings and fuzzy search capabilities.
+.SH OPTIONS
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show this help and exit
+.TP
+\fB\-v\fR, \fB\-\-version\fR
+Show the version and exit
+.TP
+\fB\-c\fR, \fB\-\-config\-file\fR=\fIVALUE\fR
+Path to config file used for current session.
+Takes precedence over standard config file.
+.TP
+\fB\-\-light-terminal\fR
+Enable color mode for light terminal background
+.TP
+\fB\-\-pdf-path\fR=\fIVALUE\fR
+Use PDF files named by citekey at the given path and its
+subdirs as value for the `file` field of the entry matching
+the citekey for the current session.
+Does not overwrite or change the original file.
+(might not work with citekeys containing special chars)
+.SH ARGUMENTS
+.TP
+\fIFILE\fR
+Path to .bib file
+.TP
+\fIDIRECTORY\fR
+Path to directory containing .bib files
+.SH CONFIGURATION
+bibiman can be configured through a config file. The standard location is:
+.RS
+.IP
+$XDG_CONFIG_HOME/bibiman/bibiman.toml
+.RE
+.IP
+Or as fallback:
+.RS
+.IP
+$HOME/.config/bibiman/bibiman.toml
+.RE
+.SS General Configuration
+The following values can be set in the config file:
+.TP
+bibfiles
+Default files/dirs which are loaded on startup (array of paths)
+.TP
+editor
+Default editor to use when editing files (default: "vim")
+.TP
+pdf_opener
+Default app to open PDFs/Epubs (default: "xdg-open")
+.TP
+url_opener
+Default app to open URLs/DOIs (default: "xdg-open")
+.TP
+file_prefix
+Prefix which is prepended to the filepath from the `file` field
+.TP
+pdf_path
+Path to folder containing PDF files with the basename "citekey.pdf"
+.TP
+note_path
+Path to folder containing note files with the basename "citekey.extension"
+.TP
+note_extensions
+Array of valid note file extensions (default: ["md", "txt"])
+.TP
+file_symbol, link_symbol, note_symbol
+Symbols to show if entry has specific attachment
+.TP
+custom_column
+Custom column for the bibentry list (default: "pubtype")
+Possible values: "journaltitle", "organization", "institution", "series", "publisher", "pubtype"
+.SS Color Configuration
+Colors can be customized using ANSI color names, 256-color indices, or HEX codes.
+Available color settings include main_text_color, highlight_text_color, entry_color,
+keyword_color, info_color, confirm_color, warn_color, bar_bg_color, popup_fg_color,
+popup_bg_color, selected_row_bg_color, note_color, file_color, link_color,
+author_color, title_color, and year_color.
+.SH KEYBINDINGS
+.TS
+allbox tab(:);
+l l.
+Key:Action
+?:Open help popup with keybindings
+j, k, Down, Up:Move down/up by 1
+Ctrl-d, Ctrl-u:Move down/up by 5
+g, G:Go to first/last entry
+h, k, Left, Right:Select previous/next entry column
+s:Sort entries by current column (toggles)
+S:Sort entries by position in file
+PageDown, PageUp, Alt-j, Alt-k:Scroll Info window
+y:Yank/copy field value of selected entry to clipboard
+e:Open editor at selected entry
+a:Add entry through DOI
+o:Open related PDF or URL/DOI
+n:Create new note file for selected entry
+TAB:Switch between entries and keywords
+/, Ctrl-f:Enter search mode
+Enter:Filter by selected keyword / Confirm search or selection
+ESC:Abort search / Reset current list
+q, Ctrl-c:Quit TUI
+.TE
+.SS Fast Selection Keys
+.TP
+o-o, o-l, o-n
+Directly open the first file|link|note for the selected entry
+.TP
+y-y
+Directly yank the citekey of the selected entry to the clipboard
+.SH FEATURES
+.TP
+Browse through bib entries using Vim-like keybindings
+.TP
+Filter entries by keywords with fuzzy search
+.TP
+Edit entries using a terminal-based editor
+.TP
+Yank/copy citekeys to system clipboard
+.TP
+Open related PDF files, URLs, and DOIs
+.TP
+Scrollbar for better navigation
+.TP
+Sort entries by column or position in bibfile
+.TP
+Load multiple files into one session
+.TP
+Add entry via DOI
+.TP
+Open and create note files for entries
+.SH EDITORS
+The following editors have been tested and work with bibiman:
+.RS
+.IP
+\(bu  Helix (hx)
+.IP
+\(bu  Vim/Neovim
+.IP
+\(bu  Emacs (terminal and GUI)
+.IP
+\(bu  Nano
+.RE
+The editor must support the `+..` argument to set the cursor line number.
+.SH EXAMPLES
+Open a single bib file:
+.RS
+.IP
+bibiman tests/biblatex-test.bib
+.RE
+Open multiple files:
+.RS
+.IP
+bibiman tests/multi-files/bibfile1.bib tests/multi-files/bibfile2.bib
+.RE
+Open directory containing bib files:
+.RS
+.IP
+bibiman tests/multi-files/
+.RE
+Mixed arguments:
+.RS
+.IP
+bibiman tests/biblatex-test.bib tests/multi-files/
+.RE
+Use custom config file:
+.RS
+.IP
+bibiman --config-file="/path/to/temporary/config" /path/to/bibfile.bib
+.RE
+.SH FILES
+.TP
+$XDG_CONFIG_HOME/bibiman/bibiman.toml
+Main configuration file
+.TP
+$HOME/.config/bibiman/bibiman.toml
+Fallback configuration file location
+.SH AUTHOR
+Lukeflo <lukeflo_git@posteo.de>
+.SH "REPORTING BUGS"
+Report issues at: https://codeberg.org/lukeflo/bibiman/issues
+.SH "SEE ALSO"
+The full documentation is available at: https://codeberg.org/lukeflo/bibiman
\ No newline at end of file