.\" Man page generated from reStructuredText.
.
.TH KUPFER 1 "2017" "" ""
.SH NAME
kupfer \- Convenient command and access tool for applications and documents
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBkupfer\fP [ \fIOPTIONS\fP | \fIFILE\fP ... ]
\fBkupfer\-exec\fP \fIFILE\fP ...
.fi
.sp
.SH DESCRIPTION
.sp
Kupfer is an interface for quick and convenient access to applications
and their documents.
.sp
The most typical use is to find a specific application and launch it. We
have tried to make Kupfer easy to extend with plugins so that this
quick\-access paradigm can be extended to many more objects than just
applications.
.sp
\fBkupfer\-exec\fP is a helper script that can execute commands saved to
file, but only by connecting to an already running instance of Kupfer.
.SH SPAWNING
.sp
Running kupfer on the command line (without options) will try to show
the program it if already running.
.sp
Kupfer can be invoked with a list of files
.INDENT 0.0
.INDENT 3.5
\fBkupfer\fP \fIFILE\fP ...
.UNINDENT
.UNINDENT
.sp
The file paths will be sent to and selected in an already running
instance of the program.
.sp
You may also pipe text to \fBkupfer\fP to pass it to a currently running
instance.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-\-no\-splash
Launch without presenting main interface
.TP
.B \-\-debug
Enable more verbose output that can help understanding
the program\(aqs operation.
.TP
.B \-\-list\-plugins
List all installed plugins by their identifier, version
and description.
.UNINDENT
.sp
The following are options for internal use
.INDENT 0.0
.TP
.BI \-\-exec\-helper\fB= HELPER
Run plugin helper program, which should be the
name of a module inside kupfer.
.UNINDENT
.sp
The following are generic options
.INDENT 0.0
.TP
.B \-\-help
Display usage information
.TP
.B \-\-version
Display version information
.UNINDENT
.SH CONFIGURATION
.sp
Custom plugins are added to kupfer by installing them to the directory
\fI~/.local/share/kupfer/plugins\fP, or any kupfer/plugins directory in any
of \fB$XDG_DATA_DIRS\fP\&.
.SH ENVIRONMENT VARIABLES
.sp
If \fIKUPFER_NO_CUSTOM_PLUGINS\fP is set, only allow loading built\-in
plugins (installed in the program\(aqs python package).
.sp
If \fIKUPFER_NO_CACHE\fP is set, do not load from or write to any source
cache files.
.sp
If \fIKUPFER_NO_KEYBINDER\fP is set do not use \fBKeybinder\fP even if it is
installed.
.\" vim: ft=rst tw=72
.
.\" this document best viewed with::
.\" rst2pdf Quickstart.rst && xdg-open Quickstart.pdf
.
.SH AUTHOR
Ulrik Sverdrup
.\" Generated by docutils manpage writer.
.