Add a manual page.
Vincent Bernat
10 years ago
|
0 |
.\" Copyright (c) 2014 Vincent Bernat <bernat@debian.org>
|
|
1 |
.\"
|
|
2 |
.\" This file is licensed as CC0.
|
|
3 |
.\"
|
|
4 |
.Dd January 25, 2014
|
|
5 |
.Dt go-bindata 8
|
|
6 |
.Os
|
|
7 |
.Sh NAME
|
|
8 |
.Nm go-bindata
|
|
9 |
.Nd embed data in a Go program
|
|
10 |
.Sh SYNOPSIS
|
|
11 |
.Nm
|
|
12 |
.Op options
|
|
13 |
.Ar input
|
|
14 |
.Op Ar output
|
|
15 |
.Sh DESCRIPTION
|
|
16 |
.Nm
|
|
17 |
converts any file into managable Go source code. It is
|
|
18 |
useful for embedding binary data into a Go program. The file data is
|
|
19 |
optionally gzip compressed before being converted to a raw byte
|
|
20 |
slice.
|
|
21 |
.Pp
|
|
22 |
.Ar input
|
|
23 |
is the input directory containing the assets to incorporate while
|
|
24 |
.Ar output
|
|
25 |
is the optional output file containing the appropriate Go code to load
|
|
26 |
assets.
|
|
27 |
.Pp
|
|
28 |
The options are as follows:
|
|
29 |
.Bl -tag -width Ds
|
|
30 |
.It Fl debug
|
|
31 |
Do not embed the assets, but provide the embedding API. Contents will
|
|
32 |
still be loaded from disk.
|
|
33 |
.It Fl nocompress
|
|
34 |
Assets will *not* be GZIP compressed when this flag is specified.
|
|
35 |
.It Fl nomemcopy
|
|
36 |
Use a .rodata hack to get rid of unnecessary memcopies. Refer to the
|
|
37 |
documentation to see what implications this carries.
|
|
38 |
.It Fl pkg Ar package
|
|
39 |
Package name to use in the generated code.
|
|
40 |
.It Fl prefix Ar prefix
|
|
41 |
Optional path prefix to strip off asset names.
|
|
42 |
.It Fl r
|
|
43 |
Recursive processing of the target directory and all its
|
|
44 |
sub-directories.
|
|
45 |
.It Fl tags Ar tags
|
|
46 |
Optional set of build tags to include.
|
|
47 |
.Sh AUTHORS
|
|
48 |
.An -nosplit
|
|
49 |
The
|
|
50 |
.Nm
|
|
51 |
program was written by
|
|
52 |
.An Jim Teeuwen .
|