The electron-tools Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The electron-tools Reference Manual

This is the electron-tools Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:36:28 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

electron-tools

Build Status

A set of tools to download and extract Electron binaries.

License

Copyright (c) 2015–2016 Fernando Borretti

Licensed under the MIT License


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


Previous: , Up: Systems   [Contents][Index]

2.1 electron-tools

Maintainer

Fernando Borretti <eudoxiahp@gmail.com>

Author

Fernando Borretti <eudoxiahp@gmail.com>

Home Page

https://github.com/ceramic/electron-tools

Source Control

(:git "git@github.com:ceramic/electron-tools.git")

Bug Tracker

https://github.com/ceramic/electron-tools/issues

License

MIT

Description

Download, extract, and run Electron binaries.

Long Description

# electron-tools

[![Build Status](https://travis-ci.org/ceramic/electron-tools.svg?branch=master)](https://travis-ci.org/ceramic/electron-tools)

A set of tools to download and extract [Electron][electron] binaries.

[electron]: http://electron.atom.io/

# License

Copyright (c) 2015–2016 Fernando Borretti

Licensed under the MIT License.

Version

0.1

Dependencies
Source

electron-tools.asd (file)

Component

src (module)


Next: , Previous: , Up: Top   [Contents][Index]

3 Modules

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


Previous: , Up: Modules   [Contents][Index]

3.1 electron-tools/src

Parent

electron-tools (system)

Location

src/

Component

electron-tools.lisp (file)


Next: , Previous: , Up: Top   [Contents][Index]

4 Files

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


Previous: , Up: Files   [Contents][Index]

4.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

4.1.1 electron-tools.asd

Location

electron-tools.asd

Systems

electron-tools (system)


Previous: , Up: Lisp files   [Contents][Index]

4.1.2 electron-tools/src/electron-tools.lisp

Parent

src (module)

Location

src/electron-tools.lisp

Packages

electron-tools

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Packages

Packages are listed by definition order.


Previous: , Up: Packages   [Contents][Index]

5.1 electron-tools

Tools for Electron.

Source

electron-tools.lisp (file)

Use List

common-lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

6 Definitions

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


Previous: , Up: Definitions   [Contents][Index]

6.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

6.1.1 Special variables

Special Variable: +download-url+

A format string for the download URL. Values are: version, version, operating system, architecture.

Package

electron-tools

Source

electron-tools.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

6.1.2 Functions

Function: app-directory DIRECTORY &key OPERATING-SYSTEM

The pathname to the application directory of an Electron release.

Package

electron-tools

Source

electron-tools.lisp (file)

Function: binary-pathname DIRECTORY &key OPERATING-SYSTEM

The pathname to the Electron binary inside the directory it was extracted to.

Package

electron-tools

Source

electron-tools.lisp (file)

Function: download PATHNAME &key OPERATING-SYSTEM VERSION ARCHITECTURE

Download a release to a pathname.

Package

electron-tools

Source

electron-tools.lisp (file)

Function: download-url &key OPERATING-SYSTEM VERSION ARCHITECTURE

A download link to the specified release.

Package

electron-tools

Source

electron-tools.lisp (file)

Function: extract PATHNAME

Extract an Electron snapshot into its containing directory.

Package

electron-tools

Source

electron-tools.lisp (file)

Function: get-release DIRECTORY &key OPERATING-SYSTEM VERSION ARCHITECTURE

Download an Electron release to the directory.

Package

electron-tools

Source

electron-tools.lisp (file)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   E   F   L   M  
Index Entry  Section

E
electron-tools.asd: The electron-tools<dot>asd file
electron-tools/src: The electron-tools/src module
electron-tools/src/electron-tools.lisp: The electron-tools/src/electron-tools<dot>lisp file

F
File, Lisp, electron-tools.asd: The electron-tools<dot>asd file
File, Lisp, electron-tools/src/electron-tools.lisp: The electron-tools/src/electron-tools<dot>lisp file

L
Lisp File, electron-tools.asd: The electron-tools<dot>asd file
Lisp File, electron-tools/src/electron-tools.lisp: The electron-tools/src/electron-tools<dot>lisp file

M
Module, electron-tools/src: The electron-tools/src module

Jump to:   E   F   L   M  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   A   B   D   E   F   G  
Index Entry  Section

A
app-directory: Exported functions

B
binary-pathname: Exported functions

D
download: Exported functions
download-url: Exported functions

E
extract: Exported functions

F
Function, app-directory: Exported functions
Function, binary-pathname: Exported functions
Function, download: Exported functions
Function, download-url: Exported functions
Function, extract: Exported functions
Function, get-release: Exported functions

G
get-release: Exported functions

Jump to:   A   B   D   E   F   G  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   +  
S  
Index Entry  Section

+
+download-url+: Exported special variables

S
Special Variable, +download-url+: Exported special variables

Jump to:   +  
S  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   E   P   S  
Index Entry  Section

E
electron-tools: The electron-tools system
electron-tools: The electron-tools package

P
Package, electron-tools: The electron-tools package

S
System, electron-tools: The electron-tools system

Jump to:   E   P   S