~ubuntu-branches/ubuntu/trusty/golang-bindata/trusty-proposed

« back to all changes in this revision

Viewing changes to debian/go-bindata.8

  • Committer: Package Import Robot
  • Author(s): Vincent Bernat
  • Date: 2014-01-25 20:07:31 UTC
  • Revision ID: package-import@ubuntu.com-20140125200731-u5qf0i7gs63ayiq3
Tags: 3.0.2-1
Initial package. Closes: #736624.

Show diffs side-by-side

added added

removed removed

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