You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1055 lines
40 KiB

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="generator" content="pandoc" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type="text/css">
@font-face {
font-family: octicons-link;
src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAAAZwABAAAAAACFQAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAABEU0lHAAAGaAAAAAgAAAAIAAAAAUdTVUIAAAZcAAAACgAAAAoAAQAAT1MvMgAAAyQAAABJAAAAYFYEU3RjbWFwAAADcAAAAEUAAACAAJThvmN2dCAAAATkAAAABAAAAAQAAAAAZnBnbQAAA7gAAACyAAABCUM+8IhnYXNwAAAGTAAAABAAAAAQABoAI2dseWYAAAFsAAABPAAAAZwcEq9taGVhZAAAAsgAAAA0AAAANgh4a91oaGVhAAADCAAAABoAAAAkCA8DRGhtdHgAAAL8AAAADAAAAAwGAACfbG9jYQAAAsAAAAAIAAAACABiATBtYXhwAAACqAAAABgAAAAgAA8ASm5hbWUAAAToAAABQgAAAlXu73sOcG9zdAAABiwAAAAeAAAAME3QpOBwcmVwAAAEbAAAAHYAAAB/aFGpk3jaTY6xa8JAGMW/O62BDi0tJLYQincXEypYIiGJjSgHniQ6umTsUEyLm5BV6NDBP8Tpts6F0v+k/0an2i+itHDw3v2+9+DBKTzsJNnWJNTgHEy4BgG3EMI9DCEDOGEXzDADU5hBKMIgNPZqoD3SilVaXZCER3/I7AtxEJLtzzuZfI+VVkprxTlXShWKb3TBecG11rwoNlmmn1P2WYcJczl32etSpKnziC7lQyWe1smVPy/Lt7Kc+0vWY/gAgIIEqAN9we0pwKXreiMasxvabDQMM4riO+qxM2ogwDGOZTXxwxDiycQIcoYFBLj5K3EIaSctAq2kTYiw+ymhce7vwM9jSqO8JyVd5RH9gyTt2+J/yUmYlIR0s04n6+7Vm1ozezUeLEaUjhaDSuXHwVRgvLJn1tQ7xiuVv/ocTRF42mNgZGBgYGbwZOBiAAFGJBIMAAizAFoAAABiAGIAznjaY2BkYGAA4in8zwXi+W2+MjCzMIDApSwvXzC97Z4Ig8N/BxYGZgcgl52BCSQKAA3jCV8CAABfAAAAAAQAAEB42mNgZGBg4f3vACQZQABIMjKgAmYAKEgBXgAAeNpjYGY6wTiBgZWBg2kmUxoDA4MPhGZMYzBi1AHygVLYQUCaawqDA4PChxhmh/8ODDEsvAwHgMKMIDnGL0x7gJQCAwMAJd4MFwAAAHjaY2BgYGaA4DAGRgYQkAHyGMF8NgYrIM3JIAGVYYDT+AEjAwuDFpBmA9KMDEwMCh9i/v8H8sH0/4dQc1iAmAkALaUKLgAAAHjaTY9LDsIgEIbtgqHUPpDi3gPoBVyRTmTddOmqTXThEXqrob2gQ1FjwpDvfwCBdmdXC5AVKFu3e5MfNFJ29KTQT48Ob9/lqYwOGZxeUelN2U2R6+cArgtCJpauW7UQBqnFkUsjAY/kOU1cP+DAgvxwn1chZDwUbd6CFimGXwzwF6tPbFIcjEl+vvmM/byA48e6tWrKArm4ZJlCbdsrxksL1AwWn/yBSJKpYbq8AXaaTb8AAHja28jAwOC00ZrBeQNDQOWO//sdBBgYGRiYWYAEELEwMTE4uzo5Zzo5b2BxdnFOcALxNjA6b2ByTswC8jYwg0VlNuoCTWAMqNzMzsoK1rEhNqByEyerg5PMJlYuVueETKcd/89uBpnpvIEVomeHLoMsAAe1Id4AAAAAAAB42oWQT07CQBTGv0JBhagk7HQzKxca2sJCE1hDt4QF+9JOS0nbaaYDCQfwCJ7Au3AHj+LO13FMmm6cl7785vven0kBjHCBhfpYuNa5Ph1c0e2Xu3jEvWG7UdPDLZ4N92nOm+EBXuAbHmIMSRMs+4aUEd4Nd3CHD8NdvOLTsA2GL8M9PODbcL+hD7C1xoaHeLJSEao0FEW14ckxC+TU8TxvsY6X0eLPmRhry2WVioLpkrbp84LLQPGI7c6sOiUzpWIWS5GzlSgUzzLBSikOPFTOXqly7rqx0Z1Q5BAIoZBSFihQYQOOBEdkCOgXTOHA07HAGjGWiIjaPZNW13/+lm6S9FT7rLHFJ6fQbkATOG1j2OFMucKJJsxIVfQORl+9Jyda6Sl1dUYhSCm1dyClfoeDve4qMYdLEbfqHf3O/AdDumsjAAB42mNgYoAAZQYjBmyAGYQZmdhL8zLdDEydARfoAqIAAAABAAMABwAKABMAB///AA8AAQAAAAAAAAAAAAAAAAABAAAAAA==) format('woff');
}
body {
-webkit-text-size-adjust: 100%;
text-size-adjust: 100%;
color: #333;
font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
font-size: 16px;
line-height: 1.6;
word-wrap: break-word;
}
a {
background-color: transparent;
}
a:active,
a:hover {
outline: 0;
}
strong {
font-weight: bold;
}
h1 {
font-size: 2em;
margin: 0.67em 0;
}
img {
border: 0;
}
hr {
box-sizing: content-box;
height: 0;
}
pre {
overflow: auto;
}
code,
kbd,
pre {
font-family: monospace, monospace;
font-size: 1em;
}
input {
color: inherit;
font: inherit;
margin: 0;
}
html input[disabled] {
cursor: default;
}
input {
line-height: normal;
}
input[type="checkbox"] {
box-sizing: border-box;
padding: 0;
}
table {
border-collapse: collapse;
border-spacing: 0;
}
td,
th {
padding: 0;
}
* {
box-sizing: border-box;
}
input {
font: 13px / 1.4 Helvetica, arial, nimbussansl, liberationsans, freesans, clean, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
}
a {
color: #4078c0;
text-decoration: none;
}
a:hover,
a:active {
text-decoration: underline;
}
hr {
height: 0;
margin: 15px 0;
overflow: hidden;
background: transparent;
border: 0;
border-bottom: 1px solid #ddd;
}
hr:before {
display: table;
content: "";
}
hr:after {
display: table;
clear: both;
content: "";
}
h1,
h2,
h3,
h4,
h5,
h6 {
margin-top: 15px;
margin-bottom: 15px;
line-height: 1.1;
}
h1 {
font-size: 30px;
}
h2 {
font-size: 21px;
}
h3 {
font-size: 16px;
}
h4 {
font-size: 14px;
}
h5 {
font-size: 12px;
}
h6 {
font-size: 11px;
}
blockquote {
margin: 0;
}
ul,
ol {
padding: 0;
margin-top: 0;
margin-bottom: 0;
}
ol ol,
ul ol {
list-style-type: lower-roman;
}
ul ul ol,
ul ol ol,
ol ul ol,
ol ol ol {
list-style-type: lower-alpha;
}
dd {
margin-left: 0;
}
code {
font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
font-size: 12px;
}
pre {
margin-top: 0;
margin-bottom: 0;
font: 12px Consolas, "Liberation Mono", Menlo, Courier, monospace;
}
.select::-ms-expand {
opacity: 0;
}
.octicon {
font: normal normal normal 16px/1 octicons-link;
display: inline-block;
text-decoration: none;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
-webkit-user-select: none;
-moz-user-select: none;
-ms-user-select: none;
user-select: none;
}
.octicon-link:before {
content: '\f05c';
}
.markdown-body:before {
display: table;
content: "";
}
.markdown-body:after {
display: table;
clear: both;
content: "";
}
.markdown-body>*:first-child {
margin-top: 0 !important;
}
.markdown-body>*:last-child {
margin-bottom: 0 !important;
}
a:not([href]) {
color: inherit;
text-decoration: none;
}
.anchor {
display: inline-block;
padding-right: 2px;
margin-left: -18px;
}
.anchor:focus {
outline: none;
}
h1,
h2,
h3,
h4,
h5,
h6 {
margin-top: 1em;
margin-bottom: 16px;
font-weight: bold;
line-height: 1.4;
}
h1 .octicon-link,
h2 .octicon-link,
h3 .octicon-link,
h4 .octicon-link,
h5 .octicon-link,
h6 .octicon-link {
color: #000;
vertical-align: middle;
visibility: hidden;
}
h1:hover .anchor,
h2:hover .anchor,
h3:hover .anchor,
h4:hover .anchor,
h5:hover .anchor,
h6:hover .anchor {
text-decoration: none;
}
h1:hover .anchor .octicon-link,
h2:hover .anchor .octicon-link,
h3:hover .anchor .octicon-link,
h4:hover .anchor .octicon-link,
h5:hover .anchor .octicon-link,
h6:hover .anchor .octicon-link {
visibility: visible;
}
h1 {
padding-bottom: 0.3em;
font-size: 2.25em;
line-height: 1.2;
border-bottom: 1px solid #eee;
}
h1 .anchor {
line-height: 1;
}
h2 {
padding-bottom: 0.3em;
font-size: 1.75em;
line-height: 1.225;
border-bottom: 1px solid #eee;
}
h2 .anchor {
line-height: 1;
}
h3 {
font-size: 1.5em;
line-height: 1.43;
}
h3 .anchor {
line-height: 1.2;
}
h4 {
font-size: 1.25em;
}
h4 .anchor {
line-height: 1.2;
}
h5 {
font-size: 1em;
}
h5 .anchor {
line-height: 1.1;
}
h6 {
font-size: 1em;
color: #777;
}
h6 .anchor {
line-height: 1.1;
}
p,
blockquote,
ul,
ol,
dl,
table,
pre {
margin-top: 0;
margin-bottom: 16px;
}
hr {
height: 4px;
padding: 0;
margin: 16px 0;
background-color: #e7e7e7;
border: 0 none;
}
ul,
ol {
padding-left: 2em;
}
ul ul,
ul ol,
ol ol,
ol ul {
margin-top: 0;
margin-bottom: 0;
}
li>p {
margin-top: 16px;
}
dl {
padding: 0;
}
dl dt {
padding: 0;
margin-top: 16px;
font-size: 1em;
font-style: italic;
font-weight: bold;
}
dl dd {
padding: 0 16px;
margin-bottom: 16px;
}
blockquote {
padding: 0 15px;
color: #777;
border-left: 4px solid #ddd;
}
blockquote>:first-child {
margin-top: 0;
}
blockquote>:last-child {
margin-bottom: 0;
}
table {
display: block;
width: 100%;
overflow: auto;
word-break: normal;
word-break: keep-all;
}
table th {
font-weight: bold;
}
table th,
table td {
padding: 6px 13px;
border: 1px solid #ddd;
}
table tr {
background-color: #fff;
border-top: 1px solid #ccc;
}
table tr:nth-child(2n) {
background-color: #f8f8f8;
}
img {
max-width: 100%;
box-sizing: content-box;
background-color: #fff;
}
code {
padding: 0;
padding-top: 0.2em;
padding-bottom: 0.2em;
margin: 0;
font-size: 85%;
background-color: rgba(0,0,0,0.04);
border-radius: 3px;
}
code:before,
code:after {
letter-spacing: -0.2em;
content: "\00a0";
}
pre>code {
padding: 0;
margin: 0;
font-size: 100%;
word-break: normal;
white-space: pre;
background: transparent;
border: 0;
}
.highlight {
margin-bottom: 16px;
}
.highlight pre,
pre {
padding: 16px;
overflow: auto;
font-size: 85%;
line-height: 1.45;
background-color: #f7f7f7;
border-radius: 3px;
}
.highlight pre {
margin-bottom: 0;
word-break: normal;
}
pre {
word-wrap: normal;
}
pre code {
display: inline;
max-width: initial;
padding: 0;
margin: 0;
overflow: initial;
line-height: inherit;
word-wrap: normal;
background-color: transparent;
border: 0;
}
pre code:before,
pre code:after {
content: normal;
}
kbd {
display: inline-block;
padding: 3px 5px;
font-size: 11px;
line-height: 10px;
color: #555;
vertical-align: middle;
background-color: #fcfcfc;
border: solid 1px #ccc;
border-bottom-color: #bbb;
border-radius: 3px;
box-shadow: inset 0 -1px 0 #bbb;
}
.pl-c {
color: #969896;
}
.pl-c1,
.pl-s .pl-v {
color: #0086b3;
}
.pl-e,
.pl-en {
color: #795da3;
}
.pl-s .pl-s1,
.pl-smi {
color: #333;
}
.pl-ent {
color: #63a35c;
}
.pl-k {
color: #a71d5d;
}
.pl-pds,
.pl-s,
.pl-s .pl-pse .pl-s1,
.pl-sr,
.pl-sr .pl-cce,
.pl-sr .pl-sra,
.pl-sr .pl-sre {
color: #183691;
}
.pl-v {
color: #ed6a43;
}
.pl-id {
color: #b52a1d;
}
.pl-ii {
background-color: #b52a1d;
color: #f8f8f8;
}
.pl-sr .pl-cce {
color: #63a35c;
font-weight: bold;
}
.pl-ml {
color: #693a17;
}
.pl-mh,
.pl-mh .pl-en,
.pl-ms {
color: #1d3e81;
font-weight: bold;
}
.pl-mq {
color: #008080;
}
.pl-mi {
color: #333;
font-style: italic;
}
.pl-mb {
color: #333;
font-weight: bold;
}
.pl-md {
background-color: #ffecec;
color: #bd2c00;
}
.pl-mi1 {
background-color: #eaffea;
color: #55a532;
}
.pl-mdr {
color: #795da3;
font-weight: bold;
}
.pl-mo {
color: #1d3e81;
}
kbd {
display: inline-block;
padding: 3px 5px;
font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
line-height: 10px;
color: #555;
vertical-align: middle;
background-color: #fcfcfc;
border: solid 1px #ccc;
border-bottom-color: #bbb;
border-radius: 3px;
box-shadow: inset 0 -1px 0 #bbb;
}
.task-list-item {
list-style-type: none;
}
.task-list-item+.task-list-item {
margin-top: 3px;
}
.task-list-item input {
margin: 0 0.35em 0.25em -1.6em;
vertical-align: middle;
}
:checked+.radio-label {
z-index: 1;
position: relative;
border-color: #4078c0;
}
.sourceLine {
display: inline-block;
}
code .kw { color: #000000; }
code .dt { color: #ed6a43; }
code .dv { color: #009999; }
code .bn { color: #009999; }
code .fl { color: #009999; }
code .ch { color: #009999; }
code .st { color: #183691; }
code .co { color: #969896; }
code .ot { color: #0086b3; }
code .al { color: #a61717; }
code .fu { color: #63a35c; }
code .er { color: #a61717; background-color: #e3d2d2; }
code .wa { color: #000000; }
code .cn { color: #008080; }
code .sc { color: #008080; }
code .vs { color: #183691; }
code .ss { color: #183691; }
code .im { color: #000000; }
code .va {color: #008080; }
code .cf { color: #000000; }
code .op { color: #000000; }
code .bu { color: #000000; }
code .ex { color: #000000; }
code .pp { color: #999999; }
code .at { color: #008080; }
code .do { color: #969896; }
code .an { color: #008080; }
code .cv { color: #008080; }
code .in { color: #008080; }
</style>
<style>
body {
box-sizing: border-box;
min-width: 200px;
max-width: 980px;
margin: 0 auto;
padding: 45px;
padding-top: 0px;
}
</style>
</head>
<body>
<p><a href="https://www.repostatus.org/#active"><img src="data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMTE2IiBoZWlnaHQ9IjIwIj48bGluZWFyR3JhZGllbnQgaWQ9ImIiIHgyPSIwIiB5Mj0iMTAwJSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjYmJiIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PC9saW5lYXJHcmFkaWVudD48Y2xpcFBhdGggaWQ9ImEiPjxyZWN0IHdpZHRoPSIxMTYiIGhlaWdodD0iMjAiIHJ4PSIzIiBmaWxsPSIjZmZmIi8+PC9jbGlwUGF0aD48ZyBjbGlwLXBhdGg9InVybCgjYSkiPjxwYXRoIGZpbGw9IiM1NTUiIGQ9Ik0wIDBoNzN2MjBIMHoiLz48cGF0aCBmaWxsPSIjNGMxIiBkPSJNNzMgMGg0M3YyMEg3M3oiLz48cGF0aCBmaWxsPSJ1cmwoI2IpIiBkPSJNMCAwaDExNnYyMEgweiIvPjwvZz48ZyBmaWxsPSIjZmZmIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmb250LWZhbWlseT0iRGVqYVZ1IFNhbnMsVmVyZGFuYSxHZW5ldmEsc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMSI+PHRleHQgeD0iMzYuNSIgeT0iMTUiIGZpbGw9IiMwMTAxMDEiIGZpbGwtb3BhY2l0eT0iLjMiPnJlcG8gc3RhdHVzPC90ZXh0Pjx0ZXh0IHg9IjM2LjUiIHk9IjE0Ij5yZXBvIHN0YXR1czwvdGV4dD48dGV4dCB4PSI5My41IiB5PSIxNSIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyI+QWN0aXZlPC90ZXh0Pjx0ZXh0IHg9IjkzLjUiIHk9IjE0Ij5BY3RpdmU8L3RleHQ+PC9nPjwvc3ZnPg==" alt="Project Status: Active – The project has reached a stable, usable state and is being actively developed." /></a> <a href="https://keybase.io/hrbrmstr"><img src="data:image/svg+xml;charset=utf-8;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMTEwIiBoZWlnaHQ9IjIwIj48bGluZWFyR3JhZGllbnQgaWQ9ImIiIHgyPSIwIiB5Mj0iMTAwJSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjYmJiIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PC9saW5lYXJHcmFkaWVudD48Y2xpcFBhdGggaWQ9ImEiPjxyZWN0IHdpZHRoPSIxMTAiIGhlaWdodD0iMjAiIHJ4PSIzIiBmaWxsPSIjZmZmIi8+PC9jbGlwUGF0aD48ZyBjbGlwLXBhdGg9InVybCgjYSkiPjxwYXRoIGZpbGw9IiM1NTUiIGQ9Ik0wIDBoNTd2MjBIMHoiLz48cGF0aCBmaWxsPSIjNGMxIiBkPSJNNTcgMGg1M3YyMEg1N3oiLz48cGF0aCBmaWxsPSJ1cmwoI2IpIiBkPSJNMCAwaDExMHYyMEgweiIvPjwvZz48ZyBmaWxsPSIjZmZmIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmb250LWZhbWlseT0iRGVqYVZ1IFNhbnMsVmVyZGFuYSxHZW5ldmEsc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMTAiPiA8dGV4dCB4PSIyOTUiIHk9IjE1MCIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjQ3MCI+S2V5YmFzZTwvdGV4dD48dGV4dCB4PSIyOTUiIHk9IjE0MCIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjQ3MCI+S2V5YmFzZTwvdGV4dD48dGV4dCB4PSI4MjUiIHk9IjE1MCIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjQzMCI+VmVyaWZpZWQ8L3RleHQ+PHRleHQgeD0iODI1IiB5PSIxNDAiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSI0MzAiPlZlcmlmaWVkPC90ZXh0PjwvZz4gPC9zdmc+" alt="Signed by" /></a> <img src="data:image/svg+xml;charset=utf-8;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB3aWR0aD0iMTQ0IiBoZWlnaHQ9IjIwIj48bGluZWFyR3JhZGllbnQgaWQ9ImIiIHgyPSIwIiB5Mj0iMTAwJSI+PHN0b3Agb2Zmc2V0PSIwIiBzdG9wLWNvbG9yPSIjYmJiIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PHN0b3Agb2Zmc2V0PSIxIiBzdG9wLW9wYWNpdHk9Ii4xIi8+PC9saW5lYXJHcmFkaWVudD48Y2xpcFBhdGggaWQ9ImEiPjxyZWN0IHdpZHRoPSIxNDQiIGhlaWdodD0iMjAiIHJ4PSIzIiBmaWxsPSIjZmZmIi8+PC9jbGlwUGF0aD48ZyBjbGlwLXBhdGg9InVybCgjYSkiPjxwYXRoIGZpbGw9IiM1NTUiIGQ9Ik0wIDBoMTAxdjIwSDB6Ii8+PHBhdGggZmlsbD0iIzlmOWY5ZiIgZD0iTTEwMSAwaDQzdjIwSDEwMXoiLz48cGF0aCBmaWxsPSJ1cmwoI2IpIiBkPSJNMCAwaDE0NHYyMEgweiIvPjwvZz48ZyBmaWxsPSIjZmZmIiB0ZXh0LWFuY2hvcj0ibWlkZGxlIiBmb250LWZhbWlseT0iRGVqYVZ1IFNhbnMsVmVyZGFuYSxHZW5ldmEsc2Fucy1zZXJpZiIgZm9udC1zaXplPSIxMTAiPiA8dGV4dCB4PSI1MTUiIHk9IjE1MCIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjkxMCI+U2lnbmVkIENvbW1pdHM8L3RleHQ+PHRleHQgeD0iNTE1IiB5PSIxNDAiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSI5MTAiPlNpZ25lZCBDb21taXRzPC90ZXh0Pjx0ZXh0IHg9IjEyMTUiIHk9IjE1MCIgZmlsbD0iIzAxMDEwMSIgZmlsbC1vcGFjaXR5PSIuMyIgdHJhbnNmb3JtPSJzY2FsZSguMSkiIHRleHRMZW5ndGg9IjMzMCI+MTAwJTwvdGV4dD48dGV4dCB4PSIxMjE1IiB5PSIxNDAiIHRyYW5zZm9ybT0ic2NhbGUoLjEpIiB0ZXh0TGVuZ3RoPSIzMzAiPjEwMCU8L3RleHQ+PC9nPiA8L3N2Zz4=" alt="Signed commit %" /> <a href="https://travis-ci.org/hrbrmstr/wan
<h1 id="wand">wand</h1>
<p>Retrieve Magic Attributes from Files and Directories</p>
<h2 id="description">Description</h2>
<p>MIME types are shorthand descriptors for file contents and can be determined from “magic” bytes in file headers, file contents or intuited from file extensions. Tools are provided to perform curated “magic” tests as well as mapping MIME types from a database of over 1,800 extension mappings.</p>
<h2 id="some-important-details">SOME IMPORTANT DETAILS</h2>
<p>The header checking is minimal (i.e. nowhere near as comprehensive as <code>libmagic</code>) but covers quite a bit of ground. If there are content-check types from <a href="https://github.com/threatstack/libmagic/tree/master/magic/"><code>magic sources</code></a> that you would like coded into the package, please file an issue and <em>include the full line(s)</em> from that linked <code>magic.tab</code> that you would like mapped.</p>
<h2 id="whats-inside-the-tin">What’s Inside The Tin</h2>
<p>The following functions are implemented:</p>
<ul>
<li><code>get_content_type</code>: Discover MIME type of a file based on contents</li>
<li><code>guess_content_type</code>: Guess MIME type from filename (extension)</li>
<li><code>simplemagic_mime_db</code>: File extension-to-MIME mapping data frame</li>
</ul>
<h2 id="installation">Installation</h2>
<div class="sourceCode" id="cb1"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb1-1"><a href="#cb1-1"></a><span class="kw">install.packages</span>(<span class="st">&quot;wand&quot;</span>, <span class="dt">repos =</span> <span class="st">&quot;https://cinc.rud.is&quot;</span>)</span>
<span id="cb1-2"><a href="#cb1-2"></a><span class="co"># or</span></span>
<span id="cb1-3"><a href="#cb1-3"></a>remotes<span class="op">::</span><span class="kw">install_git</span>(<span class="st">&quot;https://git.rud.is/hrbrmstr/wand.git&quot;</span>)</span>
<span id="cb1-4"><a href="#cb1-4"></a><span class="co"># or</span></span>
<span id="cb1-5"><a href="#cb1-5"></a>remotes<span class="op">::</span><span class="kw">install_git</span>(<span class="st">&quot;https://git.sr.ht/~hrbrmstr/wand&quot;</span>)</span>
<span id="cb1-6"><a href="#cb1-6"></a><span class="co"># or</span></span>
<span id="cb1-7"><a href="#cb1-7"></a>remotes<span class="op">::</span><span class="kw">install_gitlab</span>(<span class="st">&quot;hrbrmstr/wand&quot;</span>)</span>
<span id="cb1-8"><a href="#cb1-8"></a><span class="co"># or</span></span>
<span id="cb1-9"><a href="#cb1-9"></a>remotes<span class="op">::</span><span class="kw">install_bitbucket</span>(<span class="st">&quot;hrbrmstr/wand&quot;</span>)</span>
<span id="cb1-10"><a href="#cb1-10"></a><span class="co"># or</span></span>
<span id="cb1-11"><a href="#cb1-11"></a>remotes<span class="op">::</span><span class="kw">install_github</span>(<span class="st">&quot;hrbrmstr/wand&quot;</span>)</span></code></pre></div>
<p>NOTE: To use the ‘remotes’ install options you will need to have the <a href="https://github.com/r-lib/remotes">{remotes} package</a> installed.</p>
<h2 id="usage">Usage</h2>
<div class="sourceCode" id="cb2"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb2-1"><a href="#cb2-1"></a><span class="kw">library</span>(wand)</span>
<span id="cb2-2"><a href="#cb2-2"></a><span class="kw">library</span>(tidyverse)</span>
<span id="cb2-3"><a href="#cb2-3"></a></span>
<span id="cb2-4"><a href="#cb2-4"></a><span class="co"># current verison</span></span>
<span id="cb2-5"><a href="#cb2-5"></a><span class="kw">packageVersion</span>(<span class="st">&quot;wand&quot;</span>)</span>
<span id="cb2-6"><a href="#cb2-6"></a><span class="co">## [1] &#39;0.6.0&#39;</span></span></code></pre></div>
<div class="sourceCode" id="cb3"><pre class="sourceCode r"><code class="sourceCode r"><span id="cb3-1"><a href="#cb3-1"></a><span class="kw">list.files</span>(<span class="kw">system.file</span>(<span class="st">&quot;extdat&quot;</span>, <span class="dt">package=</span><span class="st">&quot;wand&quot;</span>), <span class="dt">full.names=</span><span class="ot">TRUE</span>) <span class="op">%&gt;%</span><span class="st"> </span></span>
<span id="cb3-2"><a href="#cb3-2"></a><span class="st"> </span><span class="kw">map_df</span>(<span class="op">~</span>{</span>
<span id="cb3-3"><a href="#cb3-3"></a> <span class="kw">tibble</span>(</span>
<span id="cb3-4"><a href="#cb3-4"></a> <span class="dt">fil =</span> <span class="kw">basename</span>(.x),</span>
<span id="cb3-5"><a href="#cb3-5"></a> <span class="dt">mime =</span> <span class="kw">list</span>(<span class="kw">get_content_type</span>(.x))</span>
<span id="cb3-6"><a href="#cb3-6"></a> )</span>
<span id="cb3-7"><a href="#cb3-7"></a> }) <span class="op">%&gt;%</span><span class="st"> </span></span>
<span id="cb3-8"><a href="#cb3-8"></a><span class="st"> </span><span class="kw">unnest</span>()</span></code></pre></div>
<div class="kable-table">
<table>
<thead>
<tr class="header">
<th align="left">fil</th>
<th align="left">mime</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">actions.csv</td>
<td align="left">application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</td>
</tr>
<tr class="even">
<td align="left">actions.txt</td>
<td align="left">application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</td>
</tr>
<tr class="odd">
<td align="left">actions.xlsx</td>
<td align="left">application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</td>
</tr>
<tr class="even">
<td align="left">test_128_44_jstereo.mp3</td>
<td align="left">audio/mp3</td>
</tr>
<tr class="odd">
<td align="left">test_excel_2000.xls</td>
<td align="left">application/msword</td>
</tr>
<tr class="even">
<td align="left">test_excel_spreadsheet.xml</td>
<td align="left">application/xml</td>
</tr>
<tr class="odd">
<td align="left">test_excel_web_archive.mht</td>
<td align="left">message/rfc822</td>
</tr>
<tr class="even">
<td align="left">test_excel.xlsm</td>
<td align="left">application/zip</td>
</tr>
<tr class="odd">
<td align="left">test_excel.xlsx</td>
<td align="left">application/vnd.openxmlformats-officedocument.spreadsheetml.sheet</td>
</tr>
<tr class="even">
<td align="left">test_nocompress.tif</td>
<td align="left">image/tiff</td>
</tr>
<tr class="odd">
<td align="left">test_powerpoint.pptm</td>
<td align="left">application/zip</td>
</tr>
<tr class="even">
<td align="left">test_powerpoint.pptx</td>
<td align="left">application/vnd.openxmlformats-officedocument.presentationml.presentation</td>
</tr>
<tr class="odd">
<td align="left">test_word_2000.doc</td>
<td align="left">application/msword</td>
</tr>
<tr class="even">
<td align="left">test_word_6.0_95.doc</td>
<td align="left">application/msword</td>
</tr>
<tr class="odd">
<td align="left">test_word.docm</td>
<td align="left">application/zip</td>
</tr>
<tr class="even">
<td align="left">test_word.docx</td>
<td align="left">application/vnd.openxmlformats-officedocument.wordprocessingml.document</td>
</tr>
<tr class="odd">
<td align="left">test.au</td>
<td align="left">audio/basic</td>
</tr>
<tr class="even">
<td align="left">test.bin</td>
<td align="left">application/mac-binary</td>
</tr>
<tr class="odd">
<td align="left">test.bin</td>
<td align="left">application/macbinary</td>
</tr>
<tr class="even">
<td align="left">test.bin</td>
<td align="left">application/octet-stream</td>
</tr>
<tr class="odd">
<td align="left">test.bin</td>
<td align="left">application/x-binary</td>
</tr>
<tr class="even">
<td align="left">test.bin</td>
<td align="left">application/x-macbinary</td>
</tr>
<tr class="odd">
<td align="left">test.bmp</td>
<td align="left">image/bmp</td>
</tr>
<tr class="even">
<td align="left">test.dtd</td>
<td align="left">application/xml-dtd</td>
</tr>
<tr class="odd">
<td align="left">test.emf</td>
<td align="left">application/x-msmetafile</td>
</tr>
<tr class="even">
<td align="left">test.emf</td>
<td align="left">image/emf</td>
</tr>
<tr class="odd">
<td align="left">test.eps</td>
<td align="left">application/postscript</td>
</tr>
<tr class="even">
<td align="left">test.fli</td>
<td align="left">video/flc</td>
</tr>
<tr class="odd">
<td align="left">test.fli</td>
<td align="left">video/fli</td>
</tr>
<tr class="even">
<td align="left">test.fli</td>
<td align="left">video/x-fli</td>
</tr>
<tr class="odd">
<td align="left">test.gif</td>
<td align="left">image/gif</td>
</tr>
<tr class="even">
<td align="left">test.ico</td>
<td align="left">image/vnd.microsoft.icon</td>
</tr>
<tr class="odd">
<td align="left">test.ico</td>
<td align="left">image/x-icon</td>
</tr>
<tr class="even">
<td align="left">test.jpg</td>
<td align="left">image/jpeg</td>
</tr>
<tr class="odd">
<td align="left">test.mp3</td>
<td align="left">audio/mp3</td>
</tr>
<tr class="even">
<td align="left">test.odt</td>
<td align="left">application/vnd.oasis.opendocument.text</td>
</tr>
<tr class="odd">
<td align="left">test.ogg</td>
<td align="left">application/ogg</td>
</tr>
<tr class="even">
<td align="left">test.ogg</td>
<td align="left">audio/ogg</td>
</tr>
<tr class="odd">
<td align="left">test.pcx</td>
<td align="left">image/pcx</td>
</tr>
<tr class="even">
<td align="left">test.pcx</td>
<td align="left">image/vnd.zbrush.pcx</td>
</tr>
<tr class="odd">
<td align="left">test.pcx</td>
<td align="left">image/x-pcx</td>
</tr>
<tr class="even">
<td align="left">test.pdf</td>
<td align="left">application/pdf</td>
</tr>
<tr class="odd">
<td align="left">test.pl</td>
<td align="left">application/x-perl</td>
</tr>
<tr class="even">
<td align="left">test.pl</td>
<td align="left">text/plain</td>
</tr>
<tr class="odd">
<td align="left">test.pl</td>
<td align="left">text/x-perl</td>
</tr>
<tr class="even">
<td align="left">test.pl</td>
<td align="left">text/x-script.perl</td>
</tr>
<tr class="odd">
<td align="left">test.png</td>
<td align="left">image/png</td>
</tr>
<tr class="even">
<td align="left">test.pnm</td>
<td align="left">application/x-portable-anymap</td>
</tr>
<tr class="odd">
<td align="left">test.pnm</td>
<td align="left">image/x-portable-anymap</td>
</tr>
<tr class="even">
<td align="left">test.ppm</td>
<td align="left">image/x-portable-pixmap</td>
</tr>
<tr class="odd">
<td align="left">test.ppt</td>
<td align="left">application/msword</td>
</tr>
<tr class="even">
<td align="left">test.ps</td>
<td align="left">application/postscript</td>
</tr>
<tr class="odd">
<td align="left">test.psd</td>
<td align="left">image/photoshop</td>
</tr>
<tr class="even">
<td align="left">test.py</td>
<td align="left">text/x-python</td>
</tr>
<tr class="odd">
<td align="left">test.py</td>
<td align="left">text/x-script.phyton</td>
</tr>
<tr class="even">
<td align="left">test.rtf</td>
<td align="left">application/rtf</td>
</tr>
<tr class="odd">
<td align="left">test.rtf</td>
<td align="left">application/x-rtf</td>
</tr>
<tr class="even">
<td align="left">test.rtf</td>
<td align="left">text/richtext</td>
</tr>
<tr class="odd">
<td align="left">test.rtf</td>
<td align="left">text/rtf</td>
</tr>
<tr class="even">
<td align="left">test.sh</td>
<td align="left">application/x-bsh</td>
</tr>
<tr class="odd">
<td align="left">test.sh</td>
<td align="left">application/x-sh</td>
</tr>
<tr class="even">
<td align="left">test.sh</td>
<td align="left">application/x-shar</td>
</tr>
<tr class="odd">
<td align="left">test.sh</td>
<td align="left">text/x-script.sh</td>
</tr>
<tr class="even">
<td align="left">test.sh</td>
<td align="left">text/x-sh</td>
</tr>
<tr class="odd">
<td align="left">test.tar</td>
<td align="left">application/tar</td>
</tr>
<tr class="even">
<td align="left">test.tar.gz</td>
<td align="left">application/gzip</td>
</tr>
<tr class="odd">
<td align="left">test.tar.gz</td>
<td align="left">application/octet-stream</td>
</tr>
<tr class="even">
<td align="left">test.tar.gz</td>
<td align="left">application/x-compressed</td>
</tr>
<tr class="odd">
<td align="left">test.tar.gz</td>
<td align="left">application/x-gzip</td>
</tr>
<tr class="even">
<td align="left">test.tga</td>
<td align="left">image/x-tga</td>
</tr>
<tr class="odd">
<td align="left">test.txt</td>
<td align="left">text/plain</td>
</tr>
<tr class="even">
<td align="left">test.txt.gz</td>
<td align="left">application/gzip</td>
</tr>
<tr class="odd">
<td align="left">test.txt.gz</td>
<td align="left">application/octet-stream</td>
</tr>
<tr class="even">
<td align="left">test.txt.gz</td>
<td align="left">application/x-compressed</td>
</tr>
<tr class="odd">
<td align="left">test.txt.gz</td>
<td align="left">application/x-gzip</td>
</tr>
<tr class="even">
<td align="left">test.wav</td>
<td align="left">audio/x-wav</td>
</tr>
<tr class="odd">
<td align="left">test.wmf</td>
<td align="left">application/x-msmetafile</td>
</tr>
<tr class="even">
<td align="left">test.wmf</td>
<td align="left">image/wmf</td>
</tr>
<tr class="odd">
<td align="left">test.wmf</td>
<td align="left">windows/metafile</td>
</tr>
<tr class="even">
<td align="left">test.xcf</td>
<td align="left">application/x-xcf</td>
</tr>
<tr class="odd">
<td align="left">test.xml</td>
<td align="left">application/xml</td>
</tr>
<tr class="even">
<td align="left">test.xpm</td>
<td align="left">image/x-xbitmap</td>
</tr>
<tr class="odd">
<td align="left">test.xpm</td>
<td align="left">image/x-xpixmap</td>
</tr>
<tr class="even">
<td align="left">test.xpm</td>
<td align="left">image/xpm</td>
</tr>
<tr class="odd">
<td align="left">test.zip</td>
<td align="left">application/zip</td>
</tr>
</tbody>
</table>
</div>
<h2 id="wand-metrics">wand Metrics</h2>
<table>
<thead>
<tr class="header">
<th align="left">Lang</th>
<th align="right"># Files</th>
<th align="right">(%)</th>
<th align="right">LoC</th>
<th align="right">(%)</th>
<th align="right">Blank lines</th>
<th align="right">(%)</th>
<th align="right"># Lines</th>
<th align="right">(%)</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td align="left">R</td>
<td align="right">7</td>
<td align="right">0.78</td>
<td align="right">154</td>
<td align="right">0.61</td>
<td align="right">59</td>
<td align="right">0.78</td>
<td align="right">70</td>
<td align="right">0.69</td>
</tr>
<tr class="even">
<td align="left">JSON</td>
<td align="right">1</td>
<td align="right">0.11</td>
<td align="right">80</td>
<td align="right">0.32</td>
<td align="right">0</td>
<td align="right">0.00</td>
<td align="right">0</td>
<td align="right">0.00</td>
</tr>
<tr class="odd">
<td align="left">Rmd</td>
<td align="right">1</td>
<td align="right">0.11</td>
<td align="right">17</td>
<td align="right">0.07</td>
<td align="right">17</td>
<td align="right">0.22</td>
<td align="right">31</td>
<td align="right">0.31</td>
</tr>
</tbody>
</table>
<h2 id="code-of-conduct">Code of Conduct</h2>
<p>Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.</p>
</body>
</html>