PAPIS-CONFIG(1)

NAME
papis-config - Papis Configuration

Papis uses a configuration file in INI format. You can then have several libraries which work independently from each other.

For example, maybe you want to have one library for papers and the other for some miscellaneous documents. An example for that is given below

[papers]
dir = ~/Documents/papers
[settings]
editor = vim
default-library = papers
[books]
dir = ~/Documents/books

A more complete example of a configuration file is the following

[settings]
# Open file with rifle, a nice python program
opentool = rifle
# Use gvim as a graphical editor
xeditor = gvim
# Use ranger as a file browser, too a  nice python package
file-browser = ranger
# Ask for confirmation when doing papis add ...
add-confirm = True
# Edit the info.yaml file before adding a doc into the library
# papis add --edit
add-edit = True
# Open the files before adding a document into the library
# papis add --open
add-open = True
# Define custom default match and header formats
match-format = {doc[tags]}{doc.subfolder}{doc[title]}{doc[author]}{doc[year]}
header-format = > {doc[title]:<70.70}|{doc[author]:<20.20} ({doc[year]:-<4})
# Commands that will be run when one does papis run ...
# e.g., papis run gagp will run the command below in the library folder
gagp = git commit -a && git push origin master
gs = git status
gm = git commit
gp = git push
gu = git pull
gma = git commit -a
# Define a lib
[papers]
dir = ~/Documents/papers
# Define a lib for books
[books]
dir = ~/Documents/books
# Define a lib for Videos
[videos]
dir = ~/Videos/courses
# Define a lib for contacts, why not?
# To make it work you just have to define some default settings
[contacts]
dir = ~/contacts/general
mode = contact
header-format = {doc[first_name]} {doc[last_name]}
match-format = {doc[org]} {doc[first_name]} {doc[last_name]}
browse-query-format = {doc[first_name]} {doc[last_name]}
add-open = False
rofi-gui-gui-eh = 2
rofi-gui-header-format = %(header-format)s
                     {doc[tel][cell]}
tk-gui-header-format = %(rofi-gui-header-format)s
vim-gui-header-format = Title: %(header-format)s
                        Tel  : {doc[tel]}
                        Mail : {doc[email]}
                     {doc[empty]}

DEFAULT SETTINGS

  settings

add-confirm
    Default: False

add-edit
    Default: False

add-interactive
    Default: False

add-open
    Default: False

browse-query-format
    Default: {doc[title]} {doc[author]}

browser
    Default: xdg-open

check-keys
    Default: files

default-gui
    Default: vim

default-library
    Default: papers

    Library to be open if no library has not been explicitly selected.

doc-url-key-name
    Default: doc_url

editor
    Default: xdg-open

export-text-format
    Default: {doc[author]}. {doc[title]}. {doc[journal]} {doc[pages]} {doc[month]} {doc[year]}

file-browser
    Default: xdg-open

format-doc-name
    Default: doc

header-format
    Default: {doc[title]:<70.70}|{doc[author]:<20.20} ({doc[year]:-<4})

info-name
    Default: info.yaml

match-format
    Default: {doc[tags]}{doc.subfolder}{doc[title]}{doc[author]}{doc[year]}

mode
    Default: document

mvtool
    Default: mv

notes-name
    Default: notes.tex

opentool
    Default: xdg-open

picktool
    Default: papis.pick

scripts-short-help-regex
    Default: .*papis-short-help: *(.*)

search-engine
    Default: https://duckduckgo.com

sync-command
    Default: git -C $dir pull origin master

use-cache
    Default: True

use-git
    Default: False

user-agent
    Default: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/35.0.1916.47 Safari/537.36

xeditor
    Default: xdg-open

  vim-gui

delete-key
    Default: dd

edit-key
    Default: e

header-format

Default:

    Title : {doc[title]}
    Author: {doc[author]}
    Year  : {doc[year]}
    -------

help-key
    Default: h

next-search-key
    Default: n

open-dir-key
    Default: <S-o>

open-key
    Default: o

prev-search-key
    Default: N

search-key
    Default: /

  tk-gui

activebackground
    Default: #394249

activeforeground
    Default: gray99

borderwidth
    Default: -1

clear
    Default: q

cursor
    Default: xterm

edit
    Default: e

entry-bg-odd
    Default: #273238

entry-bg-pair
    Default: #273238

entry-bg-size
    Default: 14

entry-fg
    Default: grey77

entry-font-name
    Default: Times

entry-font-size
    Default: 14

entry-font-style
    Default: normal

entry-lines
    Default: 3

exit
    Default: <Control-q>

focus_prompt
    Default: :

half_down
    Default: <Control-d>

half_up
    Default: <Control-u>

header-format

Default:

    {doc[title]}
    {doc[empty]}   {doc[author]}
    ({doc[year]:->4})

height
    Default: 1

help
    Default: h

insertbackground
    Default: red

labels-per-page
    Default: 6

match-format
    Default: {doc[tags]}{doc.subfolder}{doc[title]}{doc[author]}{doc[year]}

move_bottom
    Default: <Shift-G>

move_down
    Default: j

move_top
    Default: g

move_up
    Default: k

open
    Default: o

print_info
    Default: i

prompt-bg
    Default: black

prompt-fg
    Default: lightgreen

prompt-font-size
    Default: 14

scroll_down
    Default: <Control-e>

scroll_up
    Default: <Control-y>

window-bg
    Default: #273238

window-height
    Default: 700

window-width
    Default: 1200

  rofi-gui

case_sensitive
    Default: False

eh  Default: 3

fixed_lines
    Default: 20

fullscreen
    Default: False

header-format

Default:

    <b>{doc[title]}</b>
    {doc[empty]}  <i>{doc[author]}</i>
    {doc[empty]}  <span foreground="red">({doc[year]:->4})</span><span foreground="green">{doc[tags]}</span>

key-browse
    Default: Alt+u

key-delete
    Default: Alt+d

key-edit
    Default: Alt+e

key-help
    Default: Alt+h

key-normal-window
    Default: Alt+w

key-open
    Default: Enter

key-open-stay
    Default: Alt+o

key-quit
    Default: Alt+q

lines
    Default: 10

markup_rows
    Default: True

multi_select
    Default: True

normal_window
    Default: False

sep Default: |

width
    Default: 80

AUTHOR
Alejandro Gallo

COPYRIGHT
2017, Alejandro Gallo