← Back to branch summary

~ubuntu-branches/ubuntu/trusty/mtbl/trusty-proposed

« back to all changes in this revision

Viewing changes to man/mtbl_info.1

  • Committer: Package Import Robot
  • Author(s): Robert S. Edmonds
  • Date: 2014-02-03 13:49:21 UTC
  • mfrom: (1.1.3)
  • Revision ID: package-import@ubuntu.com-20140203134921-qx8q4ehadtih5rkd
Tags: 0.5-1
http://bugs.debian.org/737123
http://bugs.debian.org/716628
http://bugs.debian.org/736340
* New upstream release.
  - Fix detection of big endian architectures. (Closes: #737123).
  - Avoid crashing when the MTBL file is too small to include the complete
    MTBL trailer. (Closes: #716628).
* Use the pre-built manpage documentation rather than re-building the
  documentation at package build time. This avoids including potentially
  architecture dependent content in /usr/share in the -dev package when
  packages are built on different architectures on different days, due to
  the inclusion of today's date in the built man pages. (Closes: #736340).

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/mtbl_info.1
 
1
'\" t
 
2
.\"     Title: mtbl_info
 
3
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 
4
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
 
5
.\"      Date: 01/31/2014
 
6
.\"    Manual: \ \&
 
7
.\"    Source: \ \&
 
8
.\"  Language: English
 
9
.\"
 
10
.TH "MTBL_INFO" "1" "01/31/2014" "\ \&" "\ \&"
 
11
.\" -----------------------------------------------------------------
 
12
.\" * Define some portability stuff
 
13
.\" -----------------------------------------------------------------
 
14
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
15
.\" http://bugs.debian.org/507673
 
16
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
 
17
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
18
.ie \n(.g .ds Aq \(aq
 
19
.el       .ds Aq '
 
20
.\" -----------------------------------------------------------------
 
21
.\" * set default formatting
 
22
.\" -----------------------------------------------------------------
 
23
.\" disable hyphenation
 
24
.nh
 
25
.\" disable justification (adjust text to left margin only)
 
26
.ad l
 
27
.\" -----------------------------------------------------------------
 
28
.\" * MAIN CONTENT STARTS HERE *
 
29
.\" -----------------------------------------------------------------
 
30
.SH "NAME"
 
31
mtbl_info \- display information about an MTBL file
 
32
.SH "SYNOPSIS"
 
33
.sp
 
34
\fBmtbl_info\fR \fIFILE\fR [\fIFILE\fR]\&...
 
35
.SH "DESCRIPTION"
 
36
.sp
 
37
\fBmtbl_info\fR(1) displays the following information about the MTBL files specified on the command line\&.
 
38
.sp
 
39
\fIfile name\fR \(em the name of the MTBL file\&.
 
40
.sp
 
41
\fIfile size\fR \(em the total size of the MTBL file, in bytes\&.
 
42
.sp
 
43
\fIindex bytes\fR \(em the total number of bytes and proportion of the total file size consumed by the index\&.
 
44
.sp
 
45
\fIdata block bytes\fR \(em the total number of bytes and proportion of the total file size consumed by data blocks\&.
 
46
.sp
 
47
\fIdata block size\fR \(em the maximum size of an uncompressed data block\&.
 
48
.sp
 
49
\fIdata block count\fR \(em the total number of data blocks\&.
 
50
.sp
 
51
\fIentry count\fR \(em the total number of key\-value entries\&.
 
52
.sp
 
53
\fIkey bytes\fR \(em the total number of bytes that all keys in the file would occupy if stored end\-to\-end in a byte array with no delimiters\&.
 
54
.sp
 
55
\fIvalue bytes\fR \(em the total number of bytes that all values in the file would occupy if stored end\-to\-end in a byte array with no delimiters\&.
 
56
.sp
 
57
\fIcompression algorithm\fR \(em the algorithm used to compress data blocks\&. Possible values are "none", "snappy" and "zlib"\&.
 
58
.sp
 
59
\fIcompactness\fR \(em a rough metric comparing the total number of bytes in the key\-value entries with the total size of the MTBL file\&. It is calculated as (file size) / (key bytes + value bytes), and thus takes into account the gains of data block compression and prefix key compression against the overhead of the index, trailer, and data block offset arrays\&.