Browse
This command will try its best to find a source in the internet for the document at hand.
If the document has a URL key in its info.yaml file, it will use this URL
to open it in a browser. If it has a doc_url key, or a DOI, it will try
to compose URLs out of these to open it.
If none of the above work, then it will try to use a search engine with the
document’s information (using the browse-query-format
configuration option). You can select which search engine you want to use
with the search-engine setting.
Examples
By default, it will use the configuration option browse-key
to try and form a URL to browse. You can bypass this option using the -k
flag issuing the command:
papis browse -k doi einstein
This will form a URL through the DOI of the document. Similarly:
papis browse -k isbn
will form a URL through the ISBN of the document using isbnsearch.org. It can also use:
papis browse -k ads
to form a URL using the great ADS service and there you can check for similar papers, citations, references and much more. Please note that for this to work the document should have a DOI attached to it. Using:
papis browse -k whatever
will consider the key whatever from the document to be a valid URL,
assuming at this point that you’ll know what you’re doing. Finally, the default:
papis browse -k search-engine
will do a search-engine search with the data of your paper and hopefully
you’ll find it there.
Command-line interface
Open a document URL in a browser.
Usage
papis browse [OPTIONS] [QUERY]
Options
- -h, --help
Show this message and exit.
- --sort <FIELD>
Sort documents with respect to the FIELD.
- --reverse
Reverse sort order.
- -k, --key <key>
Use this key as the URL to open in the browser (e.g. doi, url, doc_url).
- -n, --print
Just print out the URL, do not open it in a browser.
- -a, --all
Apply action to all matching documents.
- --doc-folder <doc_folder>
Document folder on which to apply action.
Arguments
- QUERY
Optional argument