| <!DOCTYPE html> |
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en"> |
| <head> |
| <meta charset="UTF-8"/> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"/> |
| <meta name="generator" content="Asciidoctor 2.0.23"/> |
| <title>scalar(1)</title> |
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"/> |
| <style> |
| /*! Asciidoctor default stylesheet | MIT License | https://asciidoctor.org */ |
| /* Uncomment the following line when using as a custom stylesheet */ |
| /* @import "https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700"; */ |
| html{font-family:sans-serif;-webkit-text-size-adjust:100%} |
| a{background:none} |
| a:focus{outline:thin dotted} |
| a:active,a:hover{outline:0} |
| h1{font-size:2em;margin:.67em 0} |
| b,strong{font-weight:bold} |
| abbr{font-size:.9em} |
| abbr[title]{cursor:help;border-bottom:1px dotted #dddddf;text-decoration:none} |
| dfn{font-style:italic} |
| hr{height:0} |
| mark{background:#ff0;color:#000} |
| code,kbd,pre,samp{font-family:monospace;font-size:1em} |
| pre{white-space:pre-wrap} |
| q{quotes:"\201C" "\201D" "\2018" "\2019"} |
| small{font-size:80%} |
| sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline} |
| sup{top:-.5em} |
| sub{bottom:-.25em} |
| img{border:0} |
| svg:not(:root){overflow:hidden} |
| figure{margin:0} |
| audio,video{display:inline-block} |
| audio:not([controls]){display:none;height:0} |
| fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em} |
| legend{border:0;padding:0} |
| button,input,select,textarea{font-family:inherit;font-size:100%;margin:0} |
| button,input{line-height:normal} |
| button,select{text-transform:none} |
| button,html input[type=button],input[type=reset],input[type=submit]{-webkit-appearance:button;cursor:pointer} |
| button[disabled],html input[disabled]{cursor:default} |
| input[type=checkbox],input[type=radio]{padding:0} |
| button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0} |
| textarea{overflow:auto;vertical-align:top} |
| table{border-collapse:collapse;border-spacing:0} |
| *,::before,::after{box-sizing:border-box} |
| html,body{font-size:100%} |
| body{background:#fff;color:rgba(0,0,0,.8);padding:0;margin:0;font-family:"Noto Serif","DejaVu Serif",serif;line-height:1;position:relative;cursor:auto;-moz-tab-size:4;-o-tab-size:4;tab-size:4;word-wrap:anywhere;-moz-osx-font-smoothing:grayscale;-webkit-font-smoothing:antialiased} |
| a:hover{cursor:pointer} |
| img,object,embed{max-width:100%;height:auto} |
| object,embed{height:100%} |
| img{-ms-interpolation-mode:bicubic} |
| .left{float:left!important} |
| .right{float:right!important} |
| .text-left{text-align:left!important} |
| .text-right{text-align:right!important} |
| .text-center{text-align:center!important} |
| .text-justify{text-align:justify!important} |
| .hide{display:none} |
| img,object,svg{display:inline-block;vertical-align:middle} |
| textarea{height:auto;min-height:50px} |
| select{width:100%} |
| .subheader,.admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{line-height:1.45;color:#7a2518;font-weight:400;margin-top:0;margin-bottom:.25em} |
| div,dl,dt,dd,ul,ol,li,h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6,pre,form,p,blockquote,th,td{margin:0;padding:0} |
| a{color:#2156a5;text-decoration:underline;line-height:inherit} |
| a:hover,a:focus{color:#1d4b8f} |
| a img{border:0} |
| p{line-height:1.6;margin-bottom:1.25em;text-rendering:optimizeLegibility} |
| p aside{font-size:.875em;line-height:1.35;font-style:italic} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{font-family:"Open Sans","DejaVu Sans",sans-serif;font-weight:300;font-style:normal;color:#ba3925;text-rendering:optimizeLegibility;margin-top:1em;margin-bottom:.5em;line-height:1.0125em} |
| h1 small,h2 small,h3 small,#toctitle small,.sidebarblock>.content>.title small,h4 small,h5 small,h6 small{font-size:60%;color:#e99b8f;line-height:0} |
| h1{font-size:2.125em} |
| h2{font-size:1.6875em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.375em} |
| h4,h5{font-size:1.125em} |
| h6{font-size:1em} |
| hr{border:solid #dddddf;border-width:1px 0 0;clear:both;margin:1.25em 0 1.1875em} |
| em,i{font-style:italic;line-height:inherit} |
| strong,b{font-weight:bold;line-height:inherit} |
| small{font-size:60%;line-height:inherit} |
| code{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;font-weight:400;color:rgba(0,0,0,.9)} |
| ul,ol,dl{line-height:1.6;margin-bottom:1.25em;list-style-position:outside;font-family:inherit} |
| ul,ol{margin-left:1.5em} |
| ul li ul,ul li ol{margin-left:1.25em;margin-bottom:0} |
| ul.circle{list-style-type:circle} |
| ul.disc{list-style-type:disc} |
| ul.square{list-style-type:square} |
| ul.circle ul:not([class]),ul.disc ul:not([class]),ul.square ul:not([class]){list-style:inherit} |
| ol li ul,ol li ol{margin-left:1.25em;margin-bottom:0} |
| dl dt{margin-bottom:.3125em;font-weight:bold} |
| dl dd{margin-bottom:1.25em} |
| blockquote{margin:0 0 1.25em;padding:.5625em 1.25em 0 1.1875em;border-left:1px solid #ddd} |
| blockquote,blockquote p{line-height:1.6;color:rgba(0,0,0,.85)} |
| @media screen and (min-width:768px){h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2} |
| h1{font-size:2.75em} |
| h2{font-size:2.3125em} |
| h3,#toctitle,.sidebarblock>.content>.title{font-size:1.6875em} |
| h4{font-size:1.4375em}} |
| table{background:#fff;margin-bottom:1.25em;border:1px solid #dedede;word-wrap:normal} |
| table thead,table tfoot{background:#f7f8f7} |
| table thead tr th,table thead tr td,table tfoot tr th,table tfoot tr td{padding:.5em .625em .625em;font-size:inherit;color:rgba(0,0,0,.8);text-align:left} |
| table tr th,table tr td{padding:.5625em .625em;font-size:inherit;color:rgba(0,0,0,.8)} |
| table tr.even,table tr.alt{background:#f8f8f7} |
| table thead tr th,table tfoot tr th,table tbody tr td,table tr td,table tfoot tr td{line-height:1.6} |
| h1,h2,h3,#toctitle,.sidebarblock>.content>.title,h4,h5,h6{line-height:1.2;word-spacing:-.05em} |
| h1 strong,h2 strong,h3 strong,#toctitle strong,.sidebarblock>.content>.title strong,h4 strong,h5 strong,h6 strong{font-weight:400} |
| .center{margin-left:auto;margin-right:auto} |
| .stretch{width:100%} |
| .clearfix::before,.clearfix::after,.float-group::before,.float-group::after{content:" ";display:table} |
| .clearfix::after,.float-group::after{clear:both} |
| :not(pre).nobreak{word-wrap:normal} |
| :not(pre).nowrap{white-space:nowrap} |
| :not(pre).pre-wrap{white-space:pre-wrap} |
| :not(pre):not([class^=L])>code{font-size:.9375em;font-style:normal!important;letter-spacing:0;padding:.1em .5ex;word-spacing:-.15em;background:#f7f7f8;border-radius:4px;line-height:1.45;text-rendering:optimizeSpeed} |
| pre{color:rgba(0,0,0,.9);font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;line-height:1.45;text-rendering:optimizeSpeed} |
| pre code,pre pre{color:inherit;font-size:inherit;line-height:inherit} |
| pre>code{display:block} |
| pre.nowrap,pre.nowrap pre{white-space:pre;word-wrap:normal} |
| em em{font-style:normal} |
| strong strong{font-weight:400} |
| .keyseq{color:rgba(51,51,51,.8)} |
| kbd{font-family:"Droid Sans Mono","DejaVu Sans Mono",monospace;display:inline-block;color:rgba(0,0,0,.8);font-size:.65em;line-height:1.45;background:#f7f7f7;border:1px solid #ccc;border-radius:3px;box-shadow:0 1px 0 rgba(0,0,0,.2),inset 0 0 0 .1em #fff;margin:0 .15em;padding:.2em .5em;vertical-align:middle;position:relative;top:-.1em;white-space:nowrap} |
| .keyseq kbd:first-child{margin-left:0} |
| .keyseq kbd:last-child{margin-right:0} |
| .menuseq,.menuref{color:#000} |
| .menuseq b:not(.caret),.menuref{font-weight:inherit} |
| .menuseq{word-spacing:-.02em} |
| .menuseq b.caret{font-size:1.25em;line-height:.8} |
| .menuseq i.caret{font-weight:bold;text-align:center;width:.45em} |
| b.button::before,b.button::after{position:relative;top:-1px;font-weight:400} |
| b.button::before{content:"[";padding:0 3px 0 2px} |
| b.button::after{content:"]";padding:0 2px 0 3px} |
| p a>code:hover{color:rgba(0,0,0,.9)} |
| #header,#content,#footnotes,#footer{width:100%;margin:0 auto;max-width:62.5em;*zoom:1;position:relative;padding-left:.9375em;padding-right:.9375em} |
| #header::before,#header::after,#content::before,#content::after,#footnotes::before,#footnotes::after,#footer::before,#footer::after{content:" ";display:table} |
| #header::after,#content::after,#footnotes::after,#footer::after{clear:both} |
| #content{margin-top:1.25em} |
| #content::before{content:none} |
| #header>h1:first-child{color:rgba(0,0,0,.85);margin-top:2.25rem;margin-bottom:0} |
| #header>h1:first-child+#toc{margin-top:8px;border-top:1px solid #dddddf} |
| #header>h1:only-child{border-bottom:1px solid #dddddf;padding-bottom:8px} |
| #header .details{border-bottom:1px solid #dddddf;line-height:1.45;padding-top:.25em;padding-bottom:.25em;padding-left:.25em;color:rgba(0,0,0,.6);display:flex;flex-flow:row wrap} |
| #header .details span:first-child{margin-left:-.125em} |
| #header .details span.email a{color:rgba(0,0,0,.85)} |
| #header .details br{display:none} |
| #header .details br+span::before{content:"\00a0\2013\00a0"} |
| #header .details br+span.author::before{content:"\00a0\22c5\00a0";color:rgba(0,0,0,.85)} |
| #header .details br+span#revremark::before{content:"\00a0|\00a0"} |
| #header #revnumber{text-transform:capitalize} |
| #header #revnumber::after{content:"\00a0"} |
| #content>h1:first-child:not([class]){color:rgba(0,0,0,.85);border-bottom:1px solid #dddddf;padding-bottom:8px;margin-top:0;padding-top:1rem;margin-bottom:1.25rem} |
| #toc{border-bottom:1px solid #e7e7e9;padding-bottom:.5em} |
| #toc>ul{margin-left:.125em} |
| #toc ul.sectlevel0>li>a{font-style:italic} |
| #toc ul.sectlevel0 ul.sectlevel1{margin:.5em 0} |
| #toc ul{font-family:"Open Sans","DejaVu Sans",sans-serif;list-style-type:none} |
| #toc li{line-height:1.3334;margin-top:.3334em} |
| #toc a{text-decoration:none} |
| #toc a:active{text-decoration:underline} |
| #toctitle{color:#7a2518;font-size:1.2em} |
| @media screen and (min-width:768px){#toctitle{font-size:1.375em} |
| body.toc2{padding-left:15em;padding-right:0} |
| body.toc2 #header>h1:nth-last-child(2){border-bottom:1px solid #dddddf;padding-bottom:8px} |
| #toc.toc2{margin-top:0!important;background:#f8f8f7;position:fixed;width:15em;left:0;top:0;border-right:1px solid #e7e7e9;border-top-width:0!important;border-bottom-width:0!important;z-index:1000;padding:1.25em 1em;height:100%;overflow:auto} |
| #toc.toc2 #toctitle{margin-top:0;margin-bottom:.8rem;font-size:1.2em} |
| #toc.toc2>ul{font-size:.9em;margin-bottom:0} |
| #toc.toc2 ul ul{margin-left:0;padding-left:1em} |
| #toc.toc2 ul.sectlevel0 ul.sectlevel1{padding-left:0;margin-top:.5em;margin-bottom:.5em} |
| body.toc2.toc-right{padding-left:0;padding-right:15em} |
| body.toc2.toc-right #toc.toc2{border-right-width:0;border-left:1px solid #e7e7e9;left:auto;right:0}} |
| @media screen and (min-width:1280px){body.toc2{padding-left:20em;padding-right:0} |
| #toc.toc2{width:20em} |
| #toc.toc2 #toctitle{font-size:1.375em} |
| #toc.toc2>ul{font-size:.95em} |
| #toc.toc2 ul ul{padding-left:1.25em} |
| body.toc2.toc-right{padding-left:0;padding-right:20em}} |
| #content #toc{border:1px solid #e0e0dc;margin-bottom:1.25em;padding:1.25em;background:#f8f8f7;border-radius:4px} |
| #content #toc>:first-child{margin-top:0} |
| #content #toc>:last-child{margin-bottom:0} |
| #footer{max-width:none;background:rgba(0,0,0,.8);padding:1.25em} |
| #footer-text{color:hsla(0,0%,100%,.8);line-height:1.44} |
| #content{margin-bottom:.625em} |
| .sect1{padding-bottom:.625em} |
| @media screen and (min-width:768px){#content{margin-bottom:1.25em} |
| .sect1{padding-bottom:1.25em}} |
| .sect1:last-child{padding-bottom:0} |
| .sect1+.sect1{border-top:1px solid #e7e7e9} |
| #content h1>a.anchor,h2>a.anchor,h3>a.anchor,#toctitle>a.anchor,.sidebarblock>.content>.title>a.anchor,h4>a.anchor,h5>a.anchor,h6>a.anchor{position:absolute;z-index:1001;width:1.5ex;margin-left:-1.5ex;display:block;text-decoration:none!important;visibility:hidden;text-align:center;font-weight:400} |
| #content h1>a.anchor::before,h2>a.anchor::before,h3>a.anchor::before,#toctitle>a.anchor::before,.sidebarblock>.content>.title>a.anchor::before,h4>a.anchor::before,h5>a.anchor::before,h6>a.anchor::before{content:"\00A7";font-size:.85em;display:block;padding-top:.1em} |
| #content h1:hover>a.anchor,#content h1>a.anchor:hover,h2:hover>a.anchor,h2>a.anchor:hover,h3:hover>a.anchor,#toctitle:hover>a.anchor,.sidebarblock>.content>.title:hover>a.anchor,h3>a.anchor:hover,#toctitle>a.anchor:hover,.sidebarblock>.content>.title>a.anchor:hover,h4:hover>a.anchor,h4>a.anchor:hover,h5:hover>a.anchor,h5>a.anchor:hover,h6:hover>a.anchor,h6>a.anchor:hover{visibility:visible} |
| #content h1>a.link,h2>a.link,h3>a.link,#toctitle>a.link,.sidebarblock>.content>.title>a.link,h4>a.link,h5>a.link,h6>a.link{color:#ba3925;text-decoration:none} |
| #content h1>a.link:hover,h2>a.link:hover,h3>a.link:hover,#toctitle>a.link:hover,.sidebarblock>.content>.title>a.link:hover,h4>a.link:hover,h5>a.link:hover,h6>a.link:hover{color:#a53221} |
| details,.audioblock,.imageblock,.literalblock,.listingblock,.stemblock,.videoblock{margin-bottom:1.25em} |
| details{margin-left:1.25rem} |
| details>summary{cursor:pointer;display:block;position:relative;line-height:1.6;margin-bottom:.625rem;outline:none;-webkit-tap-highlight-color:transparent} |
| details>summary::-webkit-details-marker{display:none} |
| details>summary::before{content:"";border:solid transparent;border-left:solid;border-width:.3em 0 .3em .5em;position:absolute;top:.5em;left:-1.25rem;transform:translateX(15%)} |
| details[open]>summary::before{border:solid transparent;border-top:solid;border-width:.5em .3em 0;transform:translateY(15%)} |
| details>summary::after{content:"";width:1.25rem;height:1em;position:absolute;top:.3em;left:-1.25rem} |
| .admonitionblock td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic} |
| table.tableblock.fit-content>caption.title{white-space:nowrap;width:0} |
| .paragraph.lead>p,#preamble>.sectionbody>[class=paragraph]:first-of-type p{font-size:1.21875em;line-height:1.6;color:rgba(0,0,0,.85)} |
| .admonitionblock>table{border-collapse:separate;border:0;background:none;width:100%} |
| .admonitionblock>table td.icon{text-align:center;width:80px} |
| .admonitionblock>table td.icon img{max-width:none} |
| .admonitionblock>table td.icon .title{font-weight:bold;font-family:"Open Sans","DejaVu Sans",sans-serif;text-transform:uppercase} |
| .admonitionblock>table td.content{padding-left:1.125em;padding-right:1.25em;border-left:1px solid #dddddf;color:rgba(0,0,0,.6);word-wrap:anywhere} |
| .admonitionblock>table td.content>:last-child>:last-child{margin-bottom:0} |
| .exampleblock>.content{border:1px solid #e6e6e6;margin-bottom:1.25em;padding:1.25em;background:#fff;border-radius:4px} |
| .sidebarblock{border:1px solid #dbdbd6;margin-bottom:1.25em;padding:1.25em;background:#f3f3f2;border-radius:4px} |
| .sidebarblock>.content>.title{color:#7a2518;margin-top:0;text-align:center} |
| .exampleblock>.content>:first-child,.sidebarblock>.content>:first-child{margin-top:0} |
| .exampleblock>.content>:last-child,.exampleblock>.content>:last-child>:last-child,.exampleblock>.content .olist>ol>li:last-child>:last-child,.exampleblock>.content .ulist>ul>li:last-child>:last-child,.exampleblock>.content .qlist>ol>li:last-child>:last-child,.sidebarblock>.content>:last-child,.sidebarblock>.content>:last-child>:last-child,.sidebarblock>.content .olist>ol>li:last-child>:last-child,.sidebarblock>.content .ulist>ul>li:last-child>:last-child,.sidebarblock>.content .qlist>ol>li:last-child>:last-child{margin-bottom:0} |
| .literalblock pre,.listingblock>.content>pre{border-radius:4px;overflow-x:auto;padding:1em;font-size:.8125em} |
| @media screen and (min-width:768px){.literalblock pre,.listingblock>.content>pre{font-size:.90625em}} |
| @media screen and (min-width:1280px){.literalblock pre,.listingblock>.content>pre{font-size:1em}} |
| .literalblock pre,.listingblock>.content>pre:not(.highlight),.listingblock>.content>pre[class=highlight],.listingblock>.content>pre[class^="highlight "]{background:#f7f7f8} |
| .literalblock.output pre{color:#f7f7f8;background:rgba(0,0,0,.9)} |
| .listingblock>.content{position:relative} |
| .listingblock code[data-lang]::before{display:none;content:attr(data-lang);position:absolute;font-size:.75em;top:.425rem;right:.5rem;line-height:1;text-transform:uppercase;color:inherit;opacity:.5} |
| .listingblock:hover code[data-lang]::before{display:block} |
| .listingblock.terminal pre .command::before{content:attr(data-prompt);padding-right:.5em;color:inherit;opacity:.5} |
| .listingblock.terminal pre .command:not([data-prompt])::before{content:"$"} |
| .listingblock pre.highlightjs{padding:0} |
| .listingblock pre.highlightjs>code{padding:1em;border-radius:4px} |
| .listingblock pre.prettyprint{border-width:0} |
| .prettyprint{background:#f7f7f8} |
| pre.prettyprint .linenums{line-height:1.45;margin-left:2em} |
| pre.prettyprint li{background:none;list-style-type:inherit;padding-left:0} |
| pre.prettyprint li code[data-lang]::before{opacity:1} |
| pre.prettyprint li:not(:first-child) code[data-lang]::before{display:none} |
| table.linenotable{border-collapse:separate;border:0;margin-bottom:0;background:none} |
| table.linenotable td[class]{color:inherit;vertical-align:top;padding:0;line-height:inherit;white-space:normal} |
| table.linenotable td.code{padding-left:.75em} |
| table.linenotable td.linenos,pre.pygments .linenos{border-right:1px solid;opacity:.35;padding-right:.5em;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none} |
| pre.pygments span.linenos{display:inline-block;margin-right:.75em} |
| .quoteblock{margin:0 1em 1.25em 1.5em;display:table} |
| .quoteblock:not(.excerpt)>.title{margin-left:-1.5em;margin-bottom:.75em} |
| .quoteblock blockquote,.quoteblock p{color:rgba(0,0,0,.85);font-size:1.15rem;line-height:1.75;word-spacing:.1em;letter-spacing:0;font-style:italic;text-align:justify} |
| .quoteblock blockquote{margin:0;padding:0;border:0} |
| .quoteblock blockquote::before{content:"\201c";float:left;font-size:2.75em;font-weight:bold;line-height:.6em;margin-left:-.6em;color:#7a2518;text-shadow:0 1px 2px rgba(0,0,0,.1)} |
| .quoteblock blockquote>.paragraph:last-child p{margin-bottom:0} |
| .quoteblock .attribution{margin-top:.75em;margin-right:.5ex;text-align:right} |
| .verseblock{margin:0 1em 1.25em} |
| .verseblock pre{font-family:"Open Sans","DejaVu Sans",sans-serif;font-size:1.15rem;color:rgba(0,0,0,.85);font-weight:300;text-rendering:optimizeLegibility} |
| .verseblock pre strong{font-weight:400} |
| .verseblock .attribution{margin-top:1.25rem;margin-left:.5ex} |
| .quoteblock .attribution,.verseblock .attribution{font-size:.9375em;line-height:1.45;font-style:italic} |
| .quoteblock .attribution br,.verseblock .attribution br{display:none} |
| .quoteblock .attribution cite,.verseblock .attribution cite{display:block;letter-spacing:-.025em;color:rgba(0,0,0,.6)} |
| .quoteblock.abstract blockquote::before,.quoteblock.excerpt blockquote::before,.quoteblock .quoteblock blockquote::before{display:none} |
| .quoteblock.abstract blockquote,.quoteblock.abstract p,.quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{line-height:1.6;word-spacing:0} |
| .quoteblock.abstract{margin:0 1em 1.25em;display:block} |
| .quoteblock.abstract>.title{margin:0 0 .375em;font-size:1.15em;text-align:center} |
| .quoteblock.excerpt>blockquote,.quoteblock .quoteblock{padding:0 0 .25em 1em;border-left:.25em solid #dddddf} |
| .quoteblock.excerpt,.quoteblock .quoteblock{margin-left:0} |
| .quoteblock.excerpt blockquote,.quoteblock.excerpt p,.quoteblock .quoteblock blockquote,.quoteblock .quoteblock p{color:inherit;font-size:1.0625rem} |
| .quoteblock.excerpt .attribution,.quoteblock .quoteblock .attribution{color:inherit;font-size:.85rem;text-align:left;margin-right:0} |
| p.tableblock:last-child{margin-bottom:0} |
| td.tableblock>.content{margin-bottom:1.25em;word-wrap:anywhere} |
| td.tableblock>.content>:last-child{margin-bottom:-1.25em} |
| table.tableblock,th.tableblock,td.tableblock{border:0 solid #dedede} |
| table.grid-all>*>tr>*{border-width:1px} |
| table.grid-cols>*>tr>*{border-width:0 1px} |
| table.grid-rows>*>tr>*{border-width:1px 0} |
| table.frame-all{border-width:1px} |
| table.frame-ends{border-width:1px 0} |
| table.frame-sides{border-width:0 1px} |
| table.frame-none>colgroup+*>:first-child>*,table.frame-sides>colgroup+*>:first-child>*{border-top-width:0} |
| table.frame-none>:last-child>:last-child>*,table.frame-sides>:last-child>:last-child>*{border-bottom-width:0} |
| table.frame-none>*>tr>:first-child,table.frame-ends>*>tr>:first-child{border-left-width:0} |
| table.frame-none>*>tr>:last-child,table.frame-ends>*>tr>:last-child{border-right-width:0} |
| table.stripes-all>*>tr,table.stripes-odd>*>tr:nth-of-type(odd),table.stripes-even>*>tr:nth-of-type(even),table.stripes-hover>*>tr:hover{background:#f8f8f7} |
| th.halign-left,td.halign-left{text-align:left} |
| th.halign-right,td.halign-right{text-align:right} |
| th.halign-center,td.halign-center{text-align:center} |
| th.valign-top,td.valign-top{vertical-align:top} |
| th.valign-bottom,td.valign-bottom{vertical-align:bottom} |
| th.valign-middle,td.valign-middle{vertical-align:middle} |
| table thead th,table tfoot th{font-weight:bold} |
| tbody tr th{background:#f7f8f7} |
| tbody tr th,tbody tr th p,tfoot tr th,tfoot tr th p{color:rgba(0,0,0,.8);font-weight:bold} |
| p.tableblock>code:only-child{background:none;padding:0} |
| p.tableblock{font-size:1em} |
| ol{margin-left:1.75em} |
| ul li ol{margin-left:1.5em} |
| dl dd{margin-left:1.125em} |
| dl dd:last-child,dl dd:last-child>:last-child{margin-bottom:0} |
| li p,ul dd,ol dd,.olist .olist,.ulist .ulist,.ulist .olist,.olist .ulist{margin-bottom:.625em} |
| ul.checklist,ul.none,ol.none,ul.no-bullet,ol.no-bullet,ol.unnumbered,ul.unstyled,ol.unstyled{list-style-type:none} |
| ul.no-bullet,ol.no-bullet,ol.unnumbered{margin-left:.625em} |
| ul.unstyled,ol.unstyled{margin-left:0} |
| li>p:empty:only-child::before{content:"";display:inline-block} |
| ul.checklist>li>p:first-child{margin-left:-1em} |
| ul.checklist>li>p:first-child>.fa-square-o:first-child,ul.checklist>li>p:first-child>.fa-check-square-o:first-child{width:1.25em;font-size:.8em;position:relative;bottom:.125em} |
| ul.checklist>li>p:first-child>input[type=checkbox]:first-child{margin-right:.25em} |
| ul.inline{display:flex;flex-flow:row wrap;list-style:none;margin:0 0 .625em -1.25em} |
| ul.inline>li{margin-left:1.25em} |
| .unstyled dl dt{font-weight:400;font-style:normal} |
| ol.arabic{list-style-type:decimal} |
| ol.decimal{list-style-type:decimal-leading-zero} |
| ol.loweralpha{list-style-type:lower-alpha} |
| ol.upperalpha{list-style-type:upper-alpha} |
| ol.lowerroman{list-style-type:lower-roman} |
| ol.upperroman{list-style-type:upper-roman} |
| ol.lowergreek{list-style-type:lower-greek} |
| .hdlist>table,.colist>table{border:0;background:none} |
| .hdlist>table>tbody>tr,.colist>table>tbody>tr{background:none} |
| td.hdlist1,td.hdlist2{vertical-align:top;padding:0 .625em} |
| td.hdlist1{font-weight:bold;padding-bottom:1.25em} |
| td.hdlist2{word-wrap:anywhere} |
| .literalblock+.colist,.listingblock+.colist{margin-top:-.5em} |
| .colist td:not([class]):first-child{padding:.4em .75em 0;line-height:1;vertical-align:top} |
| .colist td:not([class]):first-child img{max-width:none} |
| .colist td:not([class]):last-child{padding:.25em 0} |
| .thumb,.th{line-height:0;display:inline-block;border:4px solid #fff;box-shadow:0 0 0 1px #ddd} |
| .imageblock.left{margin:.25em .625em 1.25em 0} |
| .imageblock.right{margin:.25em 0 1.25em .625em} |
| .imageblock>.title{margin-bottom:0} |
| .imageblock.thumb,.imageblock.th{border-width:6px} |
| .imageblock.thumb>.title,.imageblock.th>.title{padding:0 .125em} |
| .image.left,.image.right{margin-top:.25em;margin-bottom:.25em;display:inline-block;line-height:0} |
| .image.left{margin-right:.625em} |
| .image.right{margin-left:.625em} |
| a.image{text-decoration:none;display:inline-block} |
| a.image object{pointer-events:none} |
| sup.footnote,sup.footnoteref{font-size:.875em;position:static;vertical-align:super} |
| sup.footnote a,sup.footnoteref a{text-decoration:none} |
| sup.footnote a:active,sup.footnoteref a:active,#footnotes .footnote a:first-of-type:active{text-decoration:underline} |
| #footnotes{padding-top:.75em;padding-bottom:.75em;margin-bottom:.625em} |
| #footnotes hr{width:20%;min-width:6.25em;margin:-.25em 0 .75em;border-width:1px 0 0} |
| #footnotes .footnote{padding:0 .375em 0 .225em;line-height:1.3334;font-size:.875em;margin-left:1.2em;margin-bottom:.2em} |
| #footnotes .footnote a:first-of-type{font-weight:bold;text-decoration:none;margin-left:-1.05em} |
| #footnotes .footnote:last-of-type{margin-bottom:0} |
| #content #footnotes{margin-top:-.625em;margin-bottom:0;padding:.75em 0} |
| div.unbreakable{page-break-inside:avoid} |
| .big{font-size:larger} |
| .small{font-size:smaller} |
| .underline{text-decoration:underline} |
| .overline{text-decoration:overline} |
| .line-through{text-decoration:line-through} |
| .aqua{color:#00bfbf} |
| .aqua-background{background:#00fafa} |
| .black{color:#000} |
| .black-background{background:#000} |
| .blue{color:#0000bf} |
| .blue-background{background:#0000fa} |
| .fuchsia{color:#bf00bf} |
| .fuchsia-background{background:#fa00fa} |
| .gray{color:#606060} |
| .gray-background{background:#7d7d7d} |
| .green{color:#006000} |
| .green-background{background:#007d00} |
| .lime{color:#00bf00} |
| .lime-background{background:#00fa00} |
| .maroon{color:#600000} |
| .maroon-background{background:#7d0000} |
| .navy{color:#000060} |
| .navy-background{background:#00007d} |
| .olive{color:#606000} |
| .olive-background{background:#7d7d00} |
| .purple{color:#600060} |
| .purple-background{background:#7d007d} |
| .red{color:#bf0000} |
| .red-background{background:#fa0000} |
| .silver{color:#909090} |
| .silver-background{background:#bcbcbc} |
| .teal{color:#006060} |
| .teal-background{background:#007d7d} |
| .white{color:#bfbfbf} |
| .white-background{background:#fafafa} |
| .yellow{color:#bfbf00} |
| .yellow-background{background:#fafa00} |
| span.icon>.fa{cursor:default} |
| a span.icon>.fa{cursor:inherit} |
| .admonitionblock td.icon [class^="fa icon-"]{font-size:2.5em;text-shadow:1px 1px 2px rgba(0,0,0,.5);cursor:default} |
| .admonitionblock td.icon .icon-note::before{content:"\f05a";color:#19407c} |
| .admonitionblock td.icon .icon-tip::before{content:"\f0eb";text-shadow:1px 1px 2px rgba(155,155,0,.8);color:#111} |
| .admonitionblock td.icon .icon-warning::before{content:"\f071";color:#bf6900} |
| .admonitionblock td.icon .icon-caution::before{content:"\f06d";color:#bf3400} |
| .admonitionblock td.icon .icon-important::before{content:"\f06a";color:#bf0000} |
| .conum[data-value]{display:inline-block;color:#fff!important;background:rgba(0,0,0,.8);border-radius:50%;text-align:center;font-size:.75em;width:1.67em;height:1.67em;line-height:1.67em;font-family:"Open Sans","DejaVu Sans",sans-serif;font-style:normal;font-weight:bold} |
| .conum[data-value] *{color:#fff!important} |
| .conum[data-value]+b{display:none} |
| .conum[data-value]::after{content:attr(data-value)} |
| pre .conum[data-value]{position:relative;top:-.125em} |
| b.conum *{color:inherit!important} |
| .conum:not([data-value]):empty{display:none} |
| dt,th.tableblock,td.content,div.footnote{text-rendering:optimizeLegibility} |
| h1,h2,p,td.content,span.alt,summary{letter-spacing:-.01em} |
| p strong,td.content strong,div.footnote strong{letter-spacing:-.005em} |
| p,blockquote,dt,td.content,td.hdlist1,span.alt,summary{font-size:1.0625rem} |
| p{margin-bottom:1.25rem} |
| .sidebarblock p,.sidebarblock dt,.sidebarblock td.content,p.tableblock{font-size:1em} |
| .exampleblock>.content{background:#fffef7;border-color:#e0e0dc;box-shadow:0 1px 4px #e0e0dc} |
| .print-only{display:none!important} |
| @page{margin:1.25cm .75cm} |
| @media print{*{box-shadow:none!important;text-shadow:none!important} |
| html{font-size:80%} |
| a{color:inherit!important;text-decoration:underline!important} |
| a.bare,a[href^="#"],a[href^="mailto:"]{text-decoration:none!important} |
| a[href^="http:"]:not(.bare)::after,a[href^="https:"]:not(.bare)::after{content:"(" attr(href) ")";display:inline-block;font-size:.875em;padding-left:.25em} |
| abbr[title]{border-bottom:1px dotted} |
| abbr[title]::after{content:" (" attr(title) ")"} |
| pre,blockquote,tr,img,object,svg{page-break-inside:avoid} |
| thead{display:table-header-group} |
| svg{max-width:100%} |
| p,blockquote,dt,td.content{font-size:1em;orphans:3;widows:3} |
| h2,h3,#toctitle,.sidebarblock>.content>.title{page-break-after:avoid} |
| #header,#content,#footnotes,#footer{max-width:none} |
| #toc,.sidebarblock,.exampleblock>.content{background:none!important} |
| #toc{border-bottom:1px solid #dddddf!important;padding-bottom:0!important} |
| body.book #header{text-align:center} |
| body.book #header>h1:first-child{border:0!important;margin:2.5em 0 1em} |
| body.book #header .details{border:0!important;display:block;padding:0!important} |
| body.book #header .details span:first-child{margin-left:0!important} |
| body.book #header .details br{display:block} |
| body.book #header .details br+span::before{content:none!important} |
| body.book #toc{border:0!important;text-align:left!important;padding:0!important;margin:0!important} |
| body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-break-before:always} |
| .listingblock code[data-lang]::before{display:block} |
| #footer{padding:0 .9375em} |
| .hide-on-print{display:none!important} |
| .print-only{display:block!important} |
| .hide-for-print{display:none!important} |
| .show-for-print{display:inherit!important}} |
| @media amzn-kf8,print{#header>h1:first-child{margin-top:1.25rem} |
| .sect1{padding:0!important} |
| .sect1+.sect1{border:0} |
| #footer{background:none} |
| #footer-text{color:rgba(0,0,0,.6);font-size:.9em}} |
| @media amzn-kf8{#header,#content,#footnotes,#footer{padding:0}} |
| </style> |
| <style> |
| pre>code { |
| display: inline; |
| } |
| </style> |
| </head> |
| <body class="manpage"> |
| <div id="header"> |
| <h1>scalar(1) Manual Page</h1> |
| <h2 id="_name">NAME</h2> |
| <div class="sectionbody"> |
| <p>scalar - A tool for managing large Git repositories</p> |
| </div> |
| </div> |
| <div id="content"> |
| <div class="sect1"> |
| <h2 id="_synopsis">SYNOPSIS</h2> |
| <div class="sectionbody"> |
| <div class="verseblock"> |
| <pre class="content">scalar clone [--single-branch] [--branch <main-branch>] [--full-clone] |
| [--[no-]src] [--[no-]tags] [--[no-]maintenance] <url> [<enlistment>] |
| scalar list |
| scalar register [--[no-]maintenance] [<enlistment>] |
| scalar unregister [<enlistment>] |
| scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>] |
| scalar reconfigure [--maintenance=(enable|disable|keep)] [ --all | <enlistment> ] |
| scalar diagnose [<enlistment>] |
| scalar delete <enlistment></pre> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_description">DESCRIPTION</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Scalar is a repository management tool that optimizes Git for use in large |
| repositories. Scalar improves performance by configuring advanced Git settings, |
| maintaining repositories in the background, and helping to reduce data sent |
| across the network.</p> |
| </div> |
| <div class="paragraph"> |
| <p>An important Scalar concept is the enlistment: this is the top-level directory |
| of the project. It usually contains the subdirectory <code>src/</code> which is a Git |
| worktree. This encourages the separation between tracked files (inside <code>src/</code>) |
| and untracked files, such as build artifacts (outside <code>src/</code>). When registering |
| an existing Git worktree with Scalar whose name is not <code>src</code>, the enlistment |
| will be identical to the worktree.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>scalar</code> command implements various subcommands, and different options |
| depending on the subcommand. With the exception of <code>clone</code>, <code>list</code> and |
| <code>reconfigure</code> <code>--all</code>, all subcommands expect to be run in an enlistment.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The following options can be specified <em>before</em> the subcommand:</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">-C <directory></dt> |
| <dd> |
| <p>Before running the subcommand, change the working directory. This |
| option imitates the same option of <a href="git.html">git(1)</a>.</p> |
| </dd> |
| <dt class="hdlist1">-c <key>=<value></dt> |
| <dd> |
| <p>For the duration of running the specified subcommand, configure this |
| setting. This option imitates the same option of <a href="git.html">git(1)</a>.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_commands">COMMANDS</h2> |
| <div class="sectionbody"> |
| <div class="sect2"> |
| <h3 id="_clone">Clone</h3> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">clone [<options>] <url> [<enlistment>]</dt> |
| <dd> |
| <p>Clones the specified repository, similar to <a href="git-clone.html">git-clone(1)</a>. By |
| default, only commit and tree objects are cloned. Once finished, the |
| worktree is located at <em><enlistment></em><code>/src</code>.</p> |
| <div class="paragraph"> |
| <p>The sparse-checkout feature is enabled (except when run with <code>--full-clone</code>) |
| and the only files present are those in the top-level directory. Use |
| <code>git</code> <code>sparse-checkout</code> <code>set</code> to expand the set of directories you want to see, |
| or <code>git</code> <code>sparse-checkout</code> <code>disable</code> to expand to all files (see |
| <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more details). You can explore the |
| subdirectories outside your sparse-checkout by using <code>git</code> <code>ls-tree</code> |
| <code>HEAD</code>[<code>:</code><em><directory></em>].</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">-b <name></dt> |
| <dt class="hdlist1">--branch <name></dt> |
| <dd> |
| <p>Instead of checking out the branch pointed to by the cloned |
| repository’s HEAD, check out the <em><name></em> branch instead.</p> |
| </dd> |
| <dt class="hdlist1">--single-branch</dt> |
| <dt class="hdlist1">--no-single-branch</dt> |
| <dd> |
| <p>Clone only the history leading to the tip of a single branch, either |
| specified by the <code>--branch</code> option or the primary branch remote’s |
| <code>HEAD</code> points at.</p> |
| <div class="paragraph"> |
| <p>Further fetches into the resulting repository will only update the |
| remote-tracking branch for the branch this option was used for the initial |
| cloning. If the HEAD at the remote did not point at any branch when |
| <code>--single-branch</code> clone was made, no remote-tracking branch is created.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--src</dt> |
| <dt class="hdlist1">--no-src</dt> |
| <dd> |
| <p>By default, <code>scalar</code> <code>clone</code> places the cloned repository within a |
| <em><entlistment></em><code>/src</code> directory. Use <code>--no-src</code> to place the cloned |
| repository directly in the <em><enlistment></em> directory.</p> |
| </dd> |
| <dt class="hdlist1">--tags</dt> |
| <dt class="hdlist1">--no-tags</dt> |
| <dd> |
| <p>By default, <code>scalar</code> <code>clone</code> will fetch the tag objects advertised by |
| the remote and future <code>git</code> <code>fetch</code> commands will do the same. Use |
| <code>--no-tags</code> to avoid fetching tags in <code>scalar</code> <code>clone</code> and to configure |
| the repository to avoid fetching tags in the future. To fetch tags after |
| cloning with <code>--no-tags</code>, run <code>git</code> <code>fetch</code> <code>--tags</code>.</p> |
| </dd> |
| <dt class="hdlist1">--full-clone</dt> |
| <dt class="hdlist1">--no-full-clone</dt> |
| <dd> |
| <p>A sparse-checkout is initialized by default. This behavior can be |
| turned off via <code>--full-clone</code>.</p> |
| </dd> |
| <dt class="hdlist1">--maintenance</dt> |
| <dt class="hdlist1">--no-maintenance</dt> |
| <dd> |
| <p>By default, <code>scalar</code> <code>clone</code> configures the enlistment to use Git’s |
| background maintenance feature. Use the <code>--no-maintenance</code> to skip |
| this configuration.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_list">List</h3> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">list</dt> |
| <dd> |
| <p>List enlistments that are currently registered by Scalar. This |
| subcommand does not need to be run inside an enlistment.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_register">Register</h3> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">register [<enlistment>]</dt> |
| <dd> |
| <p>Adds the enlistment’s repository to the list of registered repositories |
| and starts background maintenance. If <em><enlistment></em> is not provided, |
| then the enlistment associated with the current working directory is |
| registered.</p> |
| <div class="paragraph"> |
| <p>Note: when this subcommand is called in a worktree that is called <code>src/</code>, its |
| parent directory is considered to be the Scalar enlistment. If the worktree is |
| <em>not</em> called <code>src/</code>, it itself will be considered to be the Scalar enlistment.</p> |
| </div> |
| </dd> |
| <dt class="hdlist1">--maintenance</dt> |
| <dt class="hdlist1">--no-maintenance</dt> |
| <dd> |
| <p>By default, <code>scalar</code> <code>register</code> configures the enlistment to use Git’s |
| background maintenance feature. Use the <code>--no-maintenance</code> to skip |
| this configuration. This does not disable any maintenance that may |
| already be enabled in other ways.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_unregister">Unregister</h3> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">unregister [<enlistment>]</dt> |
| <dd> |
| <p>Remove the specified repository from the list of repositories |
| registered with Scalar and stop the scheduled background maintenance.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_run">Run</h3> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [<enlistment>]</dt> |
| <dd> |
| <p>Run the given maintenance task (or all tasks, if <code>all</code> was specified). |
| Except for <code>all</code> and <code>config</code>, this subcommand simply hands off to |
| <a href="git-maintenance.html">git-maintenance(1)</a> (mapping <code>fetch</code> to <code>prefetch</code> and |
| <code>pack-files</code> to <code>incremental-repack</code>).</p> |
| <div class="paragraph"> |
| <p>These tasks are run automatically as part of the scheduled maintenance, |
| as soon as the repository is registered with Scalar. It should therefore |
| not be necessary to run this subcommand manually.</p> |
| </div> |
| <div class="paragraph"> |
| <p>The <code>config</code> task is specific to Scalar and configures all those |
| opinionated default settings that make Git work more efficiently with |
| large repositories. As this task is run as part of <code>scalar</code> <code>clone</code> |
| automatically, explicit invocations of this task are rarely needed.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_reconfigure">Reconfigure</h3> |
| <div class="paragraph"> |
| <p>After a Scalar upgrade, or when the configuration of a Scalar enlistment |
| was somehow corrupted or changed by mistake, this subcommand allows to |
| reconfigure the enlistment.</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">--all</dt> |
| <dd> |
| <p>When <code>--all</code> is specified, reconfigure all enlistments currently |
| registered with Scalar by the <code>scalar.repo</code> config key. Use this |
| option after each upgrade to get the latest features.</p> |
| </dd> |
| <dt class="hdlist1">--maintenance=(enable|disable|keep)</dt> |
| <dd> |
| <p>By default, Scalar configures the enlistment to use Git’s |
| background maintenance feature; this is the same as using the |
| <code>enable</code> value for this option. Use the <code>disable</code> value to |
| remove each considered enlistment from background maintenance. |
| Use ‘keep’ to leave the background maintenance configuration |
| untouched for these repositories.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_diagnose">Diagnose</h3> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">diagnose [<enlistment>]</dt> |
| <dd> |
| <p>When reporting issues with Scalar, it is often helpful to provide the |
| information gathered by this command, including logs and certain |
| statistics describing the data shape of the current enlistment.</p> |
| <div class="paragraph"> |
| <p>The output of this command is a .<code>zip</code> file that is written into |
| a directory adjacent to the worktree in the <code>src</code> directory.</p> |
| </div> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| <div class="sect2"> |
| <h3 id="_delete">Delete</h3> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">delete <enlistment></dt> |
| <dd> |
| <p>This subcommand lets you delete an existing Scalar enlistment from your |
| local file system, unregistering the repository.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_recommended_config_values">RECOMMENDED CONFIG VALUES</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>As part of both <code>scalar</code> <code>clone</code> and <code>scalar</code> <code>register</code>, certain Git config |
| values are set to optimize for large repositories or cross-platform support. |
| These options are updated in new Git versions according to the best known |
| advice for large repositories, and users can get the latest recommendations |
| by running <code>scalar</code> <code>reconfigure</code> [<code>--all</code>].</p> |
| </div> |
| <div class="paragraph"> |
| <p>This section lists justifications for the config values that are set in the |
| latest version.</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">am.keepCR=true</dt> |
| <dd> |
| <p>This setting is important for cross-platform development across Windows |
| and non-Windows platforms and keeping carriage return (<code>\r</code>) characters |
| in certain workflows.</p> |
| </dd> |
| <dt class="hdlist1">commitGraph.changedPaths=true</dt> |
| <dd> |
| <p>This setting helps the background maintenance steps that compute the |
| serialized commit-graph to also store changed-path Bloom filters. This |
| accelerates file history commands and allows users to automatically |
| benefit without running a foreground command.</p> |
| </dd> |
| <dt class="hdlist1">commitGraph.generationVersion=1</dt> |
| <dd> |
| <p>While the preferred version is 2 for performance reasons, existing users |
| that had version 1 by default will need special care in upgrading to |
| version 2. This is likely to change in the future as the upgrade story |
| solidifies.</p> |
| </dd> |
| <dt class="hdlist1">core.autoCRLF=false</dt> |
| <dd> |
| <p>This removes the transformation of worktree files to add CRLF line |
| endings when only LF line endings exist. This is removed for performance |
| reasons. Repositories that use tools that care about CRLF line endings |
| should commit the necessary files with those line endings instead.</p> |
| </dd> |
| <dt class="hdlist1">core.logAllRefUpdates=true</dt> |
| <dd> |
| <p>This enables the reflog on all branches. While this is a performance |
| cost for large repositories, it is frequently an important data source |
| for users to get out of bad situations or to seek support from experts.</p> |
| </dd> |
| <dt class="hdlist1">core.safeCRLF=false</dt> |
| <dd> |
| <p>Similar to <code>core.autoCRLF=false</code>, this disables checks around whether |
| the CRLF conversion is reversible. This is a performance improvement, |
| but can be dangerous if <code>core.autoCRLF</code> is reenabled by the user.</p> |
| </dd> |
| <dt class="hdlist1">credential.https://dev.azure.com.useHttpPath=true</dt> |
| <dd> |
| <p>This setting enables the <code>credential.useHttpPath</code> feature only for web |
| URLs for Azure DevOps. This is important for users interacting with that |
| service using multiple organizations and thus multiple credential |
| tokens.</p> |
| </dd> |
| <dt class="hdlist1">feature.experimental=false</dt> |
| <dd> |
| <p>This disables the "experimental" optimizations grouped under this |
| feature config. The expectation is that all valuable optimizations are |
| also set explicitly by Scalar config, and any differences are |
| intentional. Notable differences include several bitmap-related config |
| options which are disabled for client-focused Scalar repos.</p> |
| </dd> |
| <dt class="hdlist1">feature.manyFiles=false</dt> |
| <dd> |
| <p>This disables the "many files" optimizations grouped under this feature |
| config. The expectation is that all valuable optimizations are also set |
| explicitly by Scalar config, and any differences are intentional.</p> |
| </dd> |
| <dt class="hdlist1">fetch.showForcedUpdates=false</dt> |
| <dd> |
| <p>This disables the check at the end of <code>git</code> <code>fetch</code> that notifies the user |
| if the ref update was a forced update (one where the previous position |
| is not reachable from the latest position). This check can be very |
| expensive in large repositories, so is disabled and replaced with an |
| advice message. Set <code>advice.fetchShowForcedUpdates=false</code> to disable |
| this advice message.</p> |
| </dd> |
| <dt class="hdlist1">fetch.unpackLimit=1</dt> |
| <dd> |
| <p>This setting prevents Git from unpacking packfiles into loose objects |
| as they are downloaded from the server. The default limit of 100 was |
| intended as a way to prevent performance issues from too many packfiles, |
| but Scalar uses background maintenance to group packfiles and cover them |
| with a multi-pack-index, removing this issue.</p> |
| </dd> |
| <dt class="hdlist1">fetch.writeCommitGraph=false</dt> |
| <dd> |
| <p>This config setting was created to help users automatically update their |
| commit-graph files as they perform fetches. However, this takes time |
| from foreground fetches and pulls and Scalar uses background maintenance |
| for this function instead.</p> |
| </dd> |
| <dt class="hdlist1">gc.auto=0</dt> |
| <dd> |
| <p>This disables automatic garbage collection, since Scalar uses background |
| maintenance to keep the repository data in good shape.</p> |
| </dd> |
| <dt class="hdlist1">gui.GCWarning=false</dt> |
| <dd> |
| <p>Since Scalar disables garbage collection by setting <code>gc.auto=0</code>, the |
| <code>git-gui</code> tool may start to warn about this setting. Disable this |
| warning as Scalar’s background maintenance configuration makes the |
| warning irrelevant.</p> |
| </dd> |
| <dt class="hdlist1">index.skipHash=true</dt> |
| <dd> |
| <p>Disable computing the hash of the index contents as it is being written. |
| This assists with performance, especially for large index files.</p> |
| </dd> |
| <dt class="hdlist1">index.threads=true</dt> |
| <dd> |
| <p>This tells Git to automatically detect how many threads it should use |
| when reading the index due to the default value of <code>core.preloadIndex</code>, |
| which enables parallel index reads. This explicit setting also enables |
| <code>index.recordOffsetTable=true</code> to speed up parallel index reads.</p> |
| </dd> |
| <dt class="hdlist1">index.version=4</dt> |
| <dd> |
| <p>This index version adds compression to the path names, reducing the size |
| of the index in a significant way for large repos. This is an important |
| performance boost.</p> |
| </dd> |
| <dt class="hdlist1">log.excludeDecoration=refs/prefetch/*</dt> |
| <dd> |
| <p>Since Scalar enables background maintenance with the <code>incremental</code> |
| strategy, this setting avoids polluting <code>git</code> <code>log</code> output with refs |
| stored by the background prefetch operations.</p> |
| </dd> |
| <dt class="hdlist1">merge.renames=true</dt> |
| <dd> |
| <p>When computing merges in large repos, it is particularly important to |
| detect renames to maximize the potential for a result that will validate |
| correctly. Users performing merges locally are more likely to be doing |
| so because a server-side merge (via pull request or similar) resulted in |
| conflicts. While this is the default setting, it is set specifically to |
| override a potential change to <code>diff.renames</code> which a user may set for |
| performance reasons.</p> |
| </dd> |
| <dt class="hdlist1">merge.stat=false</dt> |
| <dd> |
| <p>This disables a diff output after computing a merge. This improves |
| performance of <code>git</code> <code>merge</code> for large repos while reducing noisy output.</p> |
| </dd> |
| <dt class="hdlist1">pack.useBitmaps=false</dt> |
| <dd> |
| <p>This disables the use of .<code>bitmap</code> files attached to packfiles. Bitmap |
| files are optimized for server-side use, not client-side use. Scalar |
| disables this to avoid some performance issues that can occur if a user |
| accidentally creates .<code>bitmap</code> files.</p> |
| </dd> |
| <dt class="hdlist1">pack.usePathWalk=true</dt> |
| <dd> |
| <p>This enables the <code>--path-walk</code> option to <code>git</code> <code>pack-objects</code> by default. |
| This can accelerate the computation and compression of packfiles created |
| by <code>git</code> <code>push</code> and other repack operations.</p> |
| </dd> |
| <dt class="hdlist1">receive.autoGC=false</dt> |
| <dd> |
| <p>Similar to <code>gc.auto</code>, this setting is disabled in preference of |
| background maintenance.</p> |
| </dd> |
| <dt class="hdlist1">status.aheadBehind=false</dt> |
| <dd> |
| <p>This disables the ahead/behind calculation that would normally happen |
| during a <code>git</code> <code>status</code> command. This information is frequently ignored by |
| users but can be expensive to calculate in large repos that receive |
| thousands of commits per day. The calculation is replaced with an advice |
| message that can be disabled by disabling the <code>advice.statusAheadBehind</code> |
| config.</p> |
| </dd> |
| </dl> |
| </div> |
| <div class="paragraph"> |
| <p>The following settings are different based on which platform is in use:</p> |
| </div> |
| <div class="dlist"> |
| <dl> |
| <dt class="hdlist1">core.untrackedCache=(true|false)</dt> |
| <dd> |
| <p>The untracked cache feature is important for performance benefits on |
| large repositories, but has demonstrated some bugs on Windows |
| filesystems. Thus, this is set for other platforms but disabled on |
| Windows.</p> |
| </dd> |
| <dt class="hdlist1">http.sslBackend=schannel</dt> |
| <dd> |
| <p>On Windows, the <code>openssl</code> backend has some issues with certain types of |
| remote providers and certificate types. Override the default setting to |
| avoid these common problems.</p> |
| </dd> |
| </dl> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_see_also">SEE ALSO</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p><a href="git-clone.html">git-clone(1)</a>, <a href="git-maintenance.html">git-maintenance(1)</a>.</p> |
| </div> |
| </div> |
| </div> |
| <div class="sect1"> |
| <h2 id="_git">GIT</h2> |
| <div class="sectionbody"> |
| <div class="paragraph"> |
| <p>Part of the <a href="git.html">git(1)</a> suite</p> |
| </div> |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <div id="footer-text"> |
| Last updated 2025-12-28 20:32:00 +0900 |
| </div> |
| </div> |
| </body> |
| </html> |
