diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 84 |
1 files changed, 57 insertions, 27 deletions
@@ -104,10 +104,15 @@ Or through `home-manager` config file: ### Void Linux<a name="void-linux"></a> -I maintain a [PR](https://github.com/void-linux/void-packages/pull/53803) in the -official Void package repos and hope it gets merged soon. Until that happens, -you can easily pull that PR into your local clone of Void packages and build it -with `xbps-src`. +You can install `bibiman` through `xbps`-package manager: + +```bash +# Through xbps directly +sudo xpbs-install bibiman + +# Or using xi from xtools package +xi bibiman +``` ## Usage<a name="usage"></a> @@ -122,12 +127,16 @@ POSITIONAL ARGS: <dir> Path to directory containing .bib files FLAGS: - -h, --help Show this help and exit - -v, --version Show the version and exit - -c, --config-file= Path to config file for current session needed as argument. - Takes precedence over standard config file - --light-terminal Enable color mode for light terminal background - + -h, --help Show this help and exit + -v, --version Show the version and exit + -c, --config-file=<value> Path to config file used for current session. + Takes precedence over standard config file. + --light-terminal Enable color mode for light terminal background + --pdf-dir=<value> 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)" ``` As seen, you can pass a single file, multiple files, the path of a directory @@ -200,29 +209,50 @@ url_opener = "xdg-open" # Prefix which is prepended to the filepath from the `file` field # Use absolute paths (~ for HOME works). Otherwise, loading might not work. file_prefix = "/some/path/prefix" +# Path to folder (with subfolders) containing PDF files with the basename +# of the format "citekey.pdf". Other PDF basenames are not accepted. +# Use absolute paths (~ for HOME works). Otherwise, loading might not work. +pdf_path = "/path/to/pdf-folder" ``` -If no file or dir is set as `bibfiles` value, you *have to* add a path via CLI -interface. If the `bibfiles` value is set *and* a further path (or multiple) is -provided through the CLI call, the entries of all those files will be opened in -the started `bibiman` session. +`bibfiles` -The file prefix offers the possibility to keep file paths in your `.bib` file -short: E.g. a combination of those values in config and bibfile: +: If no file or dir is set as `bibfiles` value, you *have to* add a path via CLI + interface. If the `bibfiles` value is set *and* a further path (or multiple) + is provided through the CLI call, the entries of all those files will be + opened in the started `bibiman` session. -```toml -# bibiman.toml -file_prefix = "~/Documents/literature" -``` +`file_prefix` -```bibtex -# bibfile.bib -file = {aristotle.pdf} -``` +: The `file_prefix` offers the possibility to keep file paths in your `.bib` + file short: E.g. a combination of those values in config and bibfile: + + ```toml + # bibiman.toml + file_prefix = "~/Documents/literature" + ``` + + ```latex + % bibfile.bib + file = {aristotle.pdf} + ``` + + Will result in opening the file `~/Documents/literature/aristotle.pdf` when + trying to open the PDF from inside `bibiman`. The `.bib` file itself will not + be edited! + + The prefix will only be added to filepaths which are explicitly set in the + `.bib` file itself using the `file` field. It will *not* "destroy" file paths + created through the `pdf_path` variable. Thus, it is safe to mix both + approaches if wanted! + +`pdf_path` -Will result in opening the file `~/Documents/literature/aristotle.pdf` when -trying to open the PDF from inside `bibiman`. The `.bib` file itself will not be -edited! +: The `pdf_path` is used as path wich is recursivley searched for files which + basename consists of the an entrys `citekey` plus a `.pdf` ending + (case-insensitive). Every file which matches this pattern for an existing + `citekey` is associated with the particular entry for the current `bibiman` + session and can be opened from within. ### Color Configuration<a name="color-configuration"></a> |