The trivial-open-browser Reference Manual

This is the trivial-open-browser Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 07:56:54 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

The main system appears first, followed by any subsystem dependency.


2.1 trivial-open-browser

Open the browser to a URL, on any system.

Author

Fernando Borretti

Home Page

https://github.com/eudoxia0/trivial-open-browser

License

MIT

Long Description

# trivial-open-browser

[![Quicklisp](http://quickdocs.org/badge/trivial-open-browser.svg)](http://quickdocs.org/trivial-open-browser/)

Open the browser to a URL, on any system.

~~~lisp
(trivial-open-browser:open-browser "http://www.google.com/")
~~~

By default, the library runs a shell command to open the browser on Windows,
Linux and OS X. You can customize this by setting the value of
‘*browser-function*‘ to a custom function that takes a URL as its argument and
somehow opens the browser to that URL.

# License

Copyright (c) 2014-2015 Fernando Borretti (eudoxiahp@gmail.com)

Licensed under the MIT License.

Version

0.1

Dependency

uiop (system).

Source

trivial-open-browser.asd.

Child Component

src (module).


3 Modules

Modules are listed depth-first from the system components tree.


3.1 trivial-open-browser/src

Source

trivial-open-browser.asd.

Parent Component

trivial-open-browser (system).

Child Component

trivial-open-browser.lisp (file).


4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


4.1 Lisp


4.1.1 trivial-open-browser/trivial-open-browser.asd

Source

trivial-open-browser.asd.

Parent Component

trivial-open-browser (system).

ASDF Systems

trivial-open-browser.

Packages

trivial-open-browser-asd.


4.1.2 trivial-open-browser/src/trivial-open-browser.lisp

Source

trivial-open-browser.asd.

Parent Component

src (module).

Packages

trivial-open-browser.

Public Interface
Internals

+format-string+ (special variable).


5 Packages

Packages are listed by definition order.


5.1 trivial-open-browser

Source

trivial-open-browser.lisp.

Use List

common-lisp.

Public Interface
Internals

+format-string+ (special variable).


5.2 trivial-open-browser-asd

Source

trivial-open-browser.asd.

Use List
  • asdf/interface.
  • common-lisp.

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


6.1 Public Interface


6.1.1 Special variables

Special Variable: *browser-function*

The function that gets called with the URL to open the browser. Defaults to ‘browser-function‘.

Package

trivial-open-browser.

Source

trivial-open-browser.lisp.


6.1.2 Ordinary functions

Function: open-browser (url)

Open the browser to ‘url‘.

Package

trivial-open-browser.

Source

trivial-open-browser.lisp.

Function: open-browser-through-shell (url)

Run a shell command to open ‘url‘.

Package

trivial-open-browser.

Source

trivial-open-browser.lisp.


6.2 Internals


6.2.1 Special variables

Special Variable: +format-string+
Package

trivial-open-browser.

Source

trivial-open-browser.lisp.


Appendix A Indexes


A.1 Concepts