.\"                                      Hey, EMACS: -*- nroff -*-
.TH HORIZON-POOL 1 "2018.03.31"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
horizon-pool \- Creates and edits items in the horizon EDA pool

.SH SYNOPSIS
.RI horizon-pool
create\-unit \fI<unit file>\fP | 
edit\-unit \fI<unit file>\fP | 
create\-symbol \fI<symbol file> <unit file>\fP |
create\-entity \fI<entity file> [ <unit file> ...\fP ] |
edit-entity \fI<entity file>\fP |
create-package \fI<package file>\fP |
create-padstack \fI<padstack file>\fP |
update
.br

.SH DESCRIPTION
This manual page documents the
.B horizon-pool
command.
.PP
.B horizon-pool
can be used to create and edit items in the pool. 
.PP
Most of the \-edit and \-create commands will spawn $EDITOR
with the file to be edited serialized as YAML.
.PP
Remember to run horizon-pool update after creating things

.SH OPTIONS
Details of options are included below.
.TP
.B create\-unit \fI<unit file>\fP 
.TP
.B edit\-unit \fI<unit file>\fP
.TP
.B create\-symbol \fI<symbol file> <unit file>\fP
.TP
.B create\-entity \fI<entity file> [ <unit file> ...\fP ]
.TP
.B edit-entity \fI<entity file>\fP
.TP
.B create-package \fI<package file>\fP
.TP
.B create-padstack \fI<padstack file>\fP
.TP
.B update

.SH USAGE
There is normally no need to run this command directly, as the
.B horizon-pool-mgr
interface will do these tasks. 

.SH ENVIRONMENT
This command requires the environment variable HORIZON_POOL to point
to the pool's directory (the one with the pool.json and pool.db in it)