scalar.html

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   3     "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
   5 <head>
   6 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
   7 <meta name="generator" content="AsciiDoc 10.2.0" />
   8 <title>scalar(1)</title>
   9 <style type="text/css">
  10 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
  11
  12 /* Default font. */
  13 body {
  14   font-family: Georgia,serif;
  15 }
  16
  17 /* Title font. */
  18 h1, h2, h3, h4, h5, h6,
  19 div.title, caption.title,
  20 thead, p.table.header,
  21 #toctitle,
  22 #author, #revnumber, #revdate, #revremark,
  23 #footer {
  24   font-family: Arial,Helvetica,sans-serif;
  25 }
  26
  27 body {
  28   margin: 1em 5% 1em 5%;
  29 }
  30
  31 a {
  32   color: blue;
  33   text-decoration: underline;
  34 }
  35 a:visited {
  36   color: fuchsia;
  37 }
  38
  39 em {
  40   font-style: italic;
  41   color: navy;
  42 }
  43
  44 strong {
  45   font-weight: bold;
  46   color: #083194;
  47 }
  48
  49 h1, h2, h3, h4, h5, h6 {
  50   color: #527bbd;
  51   margin-top: 1.2em;
  52   margin-bottom: 0.5em;
  53   line-height: 1.3;
  54 }
  55
  56 h1, h2, h3 {
  57   border-bottom: 2px solid silver;
  58 }
  59 h2 {
  60   padding-top: 0.5em;
  61 }
  62 h3 {
  63   float: left;
  64 }
  65 h3 + * {
  66   clear: left;
  67 }
  68 h5 {
  69   font-size: 1.0em;
  70 }
  71
  72 div.sectionbody {
  73   margin-left: 0;
  74 }
  75
  76 hr {
  77   border: 1px solid silver;
  78 }
  79
  80 p {
  81   margin-top: 0.5em;
  82   margin-bottom: 0.5em;
  83 }
  84
  85 ul, ol, li > p {
  86   margin-top: 0;
  87 }
  88 ul > li     { color: #aaa; }
  89 ul > li > * { color: black; }
  90
  91 .monospaced, code, pre {
  92   font-family: "Courier New", Courier, monospace;
  93   font-size: inherit;
  94   color: navy;
  95   padding: 0;
  96   margin: 0;
  97 }
  98 pre {
  99   white-space: pre-wrap;
 100 }
 101
 102 #author {
 103   color: #527bbd;
 104   font-weight: bold;
 105   font-size: 1.1em;
 106 }
 107 #email {
 108 }
 109 #revnumber, #revdate, #revremark {
 110 }
 111
 112 #footer {
 113   font-size: small;
 114   border-top: 2px solid silver;
 115   padding-top: 0.5em;
 116   margin-top: 4.0em;
 117 }
 118 #footer-text {
 119   float: left;
 120   padding-bottom: 0.5em;
 121 }
 122 #footer-badges {
 123   float: right;
 124   padding-bottom: 0.5em;
 125 }
 126
 127 #preamble {
 128   margin-top: 1.5em;
 129   margin-bottom: 1.5em;
 130 }
 131 div.imageblock, div.exampleblock, div.verseblock,
 132 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
 133 div.admonitionblock {
 134   margin-top: 1.0em;
 135   margin-bottom: 1.5em;
 136 }
 137 div.admonitionblock {
 138   margin-top: 2.0em;
 139   margin-bottom: 2.0em;
 140   margin-right: 10%;
 141   color: #606060;
 142 }
 143
 144 div.content { /* Block element content. */
 145   padding: 0;
 146 }
 147
 148 /* Block element titles. */
 149 div.title, caption.title {
 150   color: #527bbd;
 151   font-weight: bold;
 152   text-align: left;
 153   margin-top: 1.0em;
 154   margin-bottom: 0.5em;
 155 }
 156 div.title + * {
 157   margin-top: 0;
 158 }
 159
 160 td div.title:first-child {
 161   margin-top: 0.0em;
 162 }
 163 div.content div.title:first-child {
 164   margin-top: 0.0em;
 165 }
 166 div.content + div.title {
 167   margin-top: 0.0em;
 168 }
 169
 170 div.sidebarblock > div.content {
 171   background: #ffffee;
 172   border: 1px solid #dddddd;
 173   border-left: 4px solid #f0f0f0;
 174   padding: 0.5em;
 175 }
 176
 177 div.listingblock > div.content {
 178   border: 1px solid #dddddd;
 179   border-left: 5px solid #f0f0f0;
 180   background: #f8f8f8;
 181   padding: 0.5em;
 182 }
 183
 184 div.quoteblock, div.verseblock {
 185   padding-left: 1.0em;
 186   margin-left: 1.0em;
 187   margin-right: 10%;
 188   border-left: 5px solid #f0f0f0;
 189   color: #888;
 190 }
 191
 192 div.quoteblock > div.attribution {
 193   padding-top: 0.5em;
 194   text-align: right;
 195 }
 196
 197 div.verseblock > pre.content {
 198   font-family: inherit;
 199   font-size: inherit;
 200 }
 201 div.verseblock > div.attribution {
 202   padding-top: 0.75em;
 203   text-align: left;
 204 }
 205 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
 206 div.verseblock + div.attribution {
 207   text-align: left;
 208 }
 209
 210 div.admonitionblock .icon {
 211   vertical-align: top;
 212   font-size: 1.1em;
 213   font-weight: bold;
 214   text-decoration: underline;
 215   color: #527bbd;
 216   padding-right: 0.5em;
 217 }
 218 div.admonitionblock td.content {
 219   padding-left: 0.5em;
 220   border-left: 3px solid #dddddd;
 221 }
 222
 223 div.exampleblock > div.content {
 224   border-left: 3px solid #dddddd;
 225   padding-left: 0.5em;
 226 }
 227
 228 div.imageblock div.content { padding-left: 0; }
 229 span.image img { border-style: none; vertical-align: text-bottom; }
 230 a.image:visited { color: white; }
 231
 232 dl {
 233   margin-top: 0.8em;
 234   margin-bottom: 0.8em;
 235 }
 236 dt {
 237   margin-top: 0.5em;
 238   margin-bottom: 0;
 239   font-style: normal;
 240   color: navy;
 241 }
 242 dd > *:first-child {
 243   margin-top: 0.1em;
 244 }
 245
 246 ul, ol {
 247     list-style-position: outside;
 248 }
 249 ol.arabic {
 250   list-style-type: decimal;
 251 }
 252 ol.loweralpha {
 253   list-style-type: lower-alpha;
 254 }
 255 ol.upperalpha {
 256   list-style-type: upper-alpha;
 257 }
 258 ol.lowerroman {
 259   list-style-type: lower-roman;
 260 }
 261 ol.upperroman {
 262   list-style-type: upper-roman;
 263 }
 264
 265 div.compact ul, div.compact ol,
 266 div.compact p, div.compact p,
 267 div.compact div, div.compact div {
 268   margin-top: 0.1em;
 269   margin-bottom: 0.1em;
 270 }
 271
 272 tfoot {
 273   font-weight: bold;
 274 }
 275 td > div.verse {
 276   white-space: pre;
 277 }
 278
 279 div.hdlist {
 280   margin-top: 0.8em;
 281   margin-bottom: 0.8em;
 282 }
 283 div.hdlist tr {
 284   padding-bottom: 15px;
 285 }
 286 dt.hdlist1.strong, td.hdlist1.strong {
 287   font-weight: bold;
 288 }
 289 td.hdlist1 {
 290   vertical-align: top;
 291   font-style: normal;
 292   padding-right: 0.8em;
 293   color: navy;
 294 }
 295 td.hdlist2 {
 296   vertical-align: top;
 297 }
 298 div.hdlist.compact tr {
 299   margin: 0;
 300   padding-bottom: 0;
 301 }
 302
 303 .comment {
 304   background: yellow;
 305 }
 306
 307 .footnote, .footnoteref {
 308   font-size: 0.8em;
 309 }
 310
 311 span.footnote, span.footnoteref {
 312   vertical-align: super;
 313 }
 314
 315 #footnotes {
 316   margin: 20px 0 20px 0;
 317   padding: 7px 0 0 0;
 318 }
 319
 320 #footnotes div.footnote {
 321   margin: 0 0 5px 0;
 322 }
 323
 324 #footnotes hr {
 325   border: none;
 326   border-top: 1px solid silver;
 327   height: 1px;
 328   text-align: left;
 329   margin-left: 0;
 330   width: 20%;
 331   min-width: 100px;
 332 }
 333
 334 div.colist td {
 335   padding-right: 0.5em;
 336   padding-bottom: 0.3em;
 337   vertical-align: top;
 338 }
 339 div.colist td img {
 340   margin-top: 0.3em;
 341 }
 342
 343 @media print {
 344   #footer-badges { display: none; }
 345 }
 346
 347 #toc {
 348   margin-bottom: 2.5em;
 349 }
 350
 351 #toctitle {
 352   color: #527bbd;
 353   font-size: 1.1em;
 354   font-weight: bold;
 355   margin-top: 1.0em;
 356   margin-bottom: 0.1em;
 357 }
 358
 359 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
 360   margin-top: 0;
 361   margin-bottom: 0;
 362 }
 363 div.toclevel2 {
 364   margin-left: 2em;
 365   font-size: 0.9em;
 366 }
 367 div.toclevel3 {
 368   margin-left: 4em;
 369   font-size: 0.9em;
 370 }
 371 div.toclevel4 {
 372   margin-left: 6em;
 373   font-size: 0.9em;
 374 }
 375
 376 span.aqua { color: aqua; }
 377 span.black { color: black; }
 378 span.blue { color: blue; }
 379 span.fuchsia { color: fuchsia; }
 380 span.gray { color: gray; }
 381 span.green { color: green; }
 382 span.lime { color: lime; }
 383 span.maroon { color: maroon; }
 384 span.navy { color: navy; }
 385 span.olive { color: olive; }
 386 span.purple { color: purple; }
 387 span.red { color: red; }
 388 span.silver { color: silver; }
 389 span.teal { color: teal; }
 390 span.white { color: white; }
 391 span.yellow { color: yellow; }
 392
 393 span.aqua-background { background: aqua; }
 394 span.black-background { background: black; }
 395 span.blue-background { background: blue; }
 396 span.fuchsia-background { background: fuchsia; }
 397 span.gray-background { background: gray; }
 398 span.green-background { background: green; }
 399 span.lime-background { background: lime; }
 400 span.maroon-background { background: maroon; }
 401 span.navy-background { background: navy; }
 402 span.olive-background { background: olive; }
 403 span.purple-background { background: purple; }
 404 span.red-background { background: red; }
 405 span.silver-background { background: silver; }
 406 span.teal-background { background: teal; }
 407 span.white-background { background: white; }
 408 span.yellow-background { background: yellow; }
 409
 410 span.big { font-size: 2em; }
 411 span.small { font-size: 0.6em; }
 412
 413 span.underline { text-decoration: underline; }
 414 span.overline { text-decoration: overline; }
 415 span.line-through { text-decoration: line-through; }
 416
 417 div.unbreakable { page-break-inside: avoid; }
 418
 419
 420 /*
 421  * xhtml11 specific
 422  *
 423  * */
 424
 425 div.tableblock {
 426   margin-top: 1.0em;
 427   margin-bottom: 1.5em;
 428 }
 429 div.tableblock > table {
 430   border: 3px solid #527bbd;
 431 }
 432 thead, p.table.header {
 433   font-weight: bold;
 434   color: #527bbd;
 435 }
 436 p.table {
 437   margin-top: 0;
 438 }
 439 /* Because the table frame attribute is overridden by CSS in most browsers. */
 440 div.tableblock > table[frame="void"] {
 441   border-style: none;
 442 }
 443 div.tableblock > table[frame="hsides"] {
 444   border-left-style: none;
 445   border-right-style: none;
 446 }
 447 div.tableblock > table[frame="vsides"] {
 448   border-top-style: none;
 449   border-bottom-style: none;
 450 }
 451
 452
 453 /*
 454  * html5 specific
 455  *
 456  * */
 457
 458 table.tableblock {
 459   margin-top: 1.0em;
 460   margin-bottom: 1.5em;
 461 }
 462 thead, p.tableblock.header {
 463   font-weight: bold;
 464   color: #527bbd;
 465 }
 466 p.tableblock {
 467   margin-top: 0;
 468 }
 469 table.tableblock {
 470   border-width: 3px;
 471   border-spacing: 0px;
 472   border-style: solid;
 473   border-color: #527bbd;
 474   border-collapse: collapse;
 475 }
 476 th.tableblock, td.tableblock {
 477   border-width: 1px;
 478   padding: 4px;
 479   border-style: solid;
 480   border-color: #527bbd;
 481 }
 482
 483 table.tableblock.frame-topbot {
 484   border-left-style: hidden;
 485   border-right-style: hidden;
 486 }
 487 table.tableblock.frame-sides {
 488   border-top-style: hidden;
 489   border-bottom-style: hidden;
 490 }
 491 table.tableblock.frame-none {
 492   border-style: hidden;
 493 }
 494
 495 th.tableblock.halign-left, td.tableblock.halign-left {
 496   text-align: left;
 497 }
 498 th.tableblock.halign-center, td.tableblock.halign-center {
 499   text-align: center;
 500 }
 501 th.tableblock.halign-right, td.tableblock.halign-right {
 502   text-align: right;
 503 }
 504
 505 th.tableblock.valign-top, td.tableblock.valign-top {
 506   vertical-align: top;
 507 }
 508 th.tableblock.valign-middle, td.tableblock.valign-middle {
 509   vertical-align: middle;
 510 }
 511 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
 512   vertical-align: bottom;
 513 }
 514
 515
 516 /*
 517  * manpage specific
 518  *
 519  * */
 520
 521 body.manpage h1 {
 522   padding-top: 0.5em;
 523   padding-bottom: 0.5em;
 524   border-top: 2px solid silver;
 525   border-bottom: 2px solid silver;
 526 }
 527 body.manpage h2 {
 528   border-style: none;
 529 }
 530 body.manpage div.sectionbody {
 531   margin-left: 3em;
 532 }
 533
 534 @media print {
 535   body.manpage div#toc { display: none; }
 536 }
 537
 538
 539 </style>
 540 <script type="text/javascript">
 541 /*<![CDATA[*/
 542 var asciidoc = {  // Namespace.
 543
 544 /////////////////////////////////////////////////////////////////////
 545 // Table Of Contents generator
 546 /////////////////////////////////////////////////////////////////////
 547
 548 /* Author: Mihai Bazon, September 2002
 549  * http://students.infoiasi.ro/~mishoo
 550  *
 551  * Table Of Content generator
 552  * Version: 0.4
 553  *
 554  * Feel free to use this script under the terms of the GNU General Public
 555  * License, as long as you do not remove or alter this notice.
 556  */
 557
 558  /* modified by Troy D. Hanson, September 2006. License: GPL */
 559  /* modified by Stuart Rackham, 2006, 2009. License: GPL */
 560
 561 // toclevels = 1..4.
 562 toc: function (toclevels) {
 563
 564   function getText(el) {
 565     var text = "";
 566     for (var i = el.firstChild; i != null; i = i.nextSibling) {
 567       if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
 568         text += i.data;
 569       else if (i.firstChild != null)
 570         text += getText(i);
 571     }
 572     return text;
 573   }
 574
 575   function TocEntry(el, text, toclevel) {
 576     this.element = el;
 577     this.text = text;
 578     this.toclevel = toclevel;
 579   }
 580
 581   function tocEntries(el, toclevels) {
 582     var result = new Array;
 583     var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
 584     // Function that scans the DOM tree for header elements (the DOM2
 585     // nodeIterator API would be a better technique but not supported by all
 586     // browsers).
 587     var iterate = function (el) {
 588       for (var i = el.firstChild; i != null; i = i.nextSibling) {
 589         if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
 590           var mo = re.exec(i.tagName);
 591           if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
 592             result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
 593           }
 594           iterate(i);
 595         }
 596       }
 597     }
 598     iterate(el);
 599     return result;
 600   }
 601
 602   var toc = document.getElementById("toc");
 603   if (!toc) {
 604     return;
 605   }
 606
 607   // Delete existing TOC entries in case we're reloading the TOC.
 608   var tocEntriesToRemove = [];
 609   var i;
 610   for (i = 0; i < toc.childNodes.length; i++) {
 611     var entry = toc.childNodes[i];
 612     if (entry.nodeName.toLowerCase() == 'div'
 613      && entry.getAttribute("class")
 614      && entry.getAttribute("class").match(/^toclevel/))
 615       tocEntriesToRemove.push(entry);
 616   }
 617   for (i = 0; i < tocEntriesToRemove.length; i++) {
 618     toc.removeChild(tocEntriesToRemove[i]);
 619   }
 620
 621   // Rebuild TOC entries.
 622   var entries = tocEntries(document.getElementById("content"), toclevels);
 623   for (var i = 0; i < entries.length; ++i) {
 624     var entry = entries[i];
 625     if (entry.element.id == "")
 626       entry.element.id = "_toc_" + i;
 627     var a = document.createElement("a");
 628     a.href = "#" + entry.element.id;
 629     a.appendChild(document.createTextNode(entry.text));
 630     var div = document.createElement("div");
 631     div.appendChild(a);
 632     div.className = "toclevel" + entry.toclevel;
 633     toc.appendChild(div);
 634   }
 635   if (entries.length == 0)
 636     toc.parentNode.removeChild(toc);
 637 },
 638
 639
 640 /////////////////////////////////////////////////////////////////////
 641 // Footnotes generator
 642 /////////////////////////////////////////////////////////////////////
 643
 644 /* Based on footnote generation code from:
 645  * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
 646  */
 647
 648 footnotes: function () {
 649   // Delete existing footnote entries in case we're reloading the footnodes.
 650   var i;
 651   var noteholder = document.getElementById("footnotes");
 652   if (!noteholder) {
 653     return;
 654   }
 655   var entriesToRemove = [];
 656   for (i = 0; i < noteholder.childNodes.length; i++) {
 657     var entry = noteholder.childNodes[i];
 658     if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
 659       entriesToRemove.push(entry);
 660   }
 661   for (i = 0; i < entriesToRemove.length; i++) {
 662     noteholder.removeChild(entriesToRemove[i]);
 663   }
 664
 665   // Rebuild footnote entries.
 666   var cont = document.getElementById("content");
 667   var spans = cont.getElementsByTagName("span");
 668   var refs = {};
 669   var n = 0;
 670   for (i=0; i<spans.length; i++) {
 671     if (spans[i].className == "footnote") {
 672       n++;
 673       var note = spans[i].getAttribute("data-note");
 674       if (!note) {
 675         // Use [\s\S] in place of . so multi-line matches work.
 676         // Because JavaScript has no s (dotall) regex flag.
 677         note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
 678         spans[i].innerHTML =
 679           "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
 680           "' title='View footnote' class='footnote'>" + n + "</a>]";
 681         spans[i].setAttribute("data-note", note);
 682       }
 683       noteholder.innerHTML +=
 684         "<div class='footnote' id='_footnote_" + n + "'>" +
 685         "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
 686         n + "</a>. " + note + "</div>";
 687       var id =spans[i].getAttribute("id");
 688       if (id != null) refs["#"+id] = n;
 689     }
 690   }
 691   if (n == 0)
 692     noteholder.parentNode.removeChild(noteholder);
 693   else {
 694     // Process footnoterefs.
 695     for (i=0; i<spans.length; i++) {
 696       if (spans[i].className == "footnoteref") {
 697         var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
 698         href = href.match(/#.*/)[0];  // Because IE return full URL.
 699         n = refs[href];
 700         spans[i].innerHTML =
 701           "[<a href='#_footnote_" + n +
 702           "' title='View footnote' class='footnote'>" + n + "</a>]";
 703       }
 704     }
 705   }
 706 },
 707
 708 install: function(toclevels) {
 709   var timerId;
 710
 711   function reinstall() {
 712     asciidoc.footnotes();
 713     if (toclevels) {
 714       asciidoc.toc(toclevels);
 715     }
 716   }
 717
 718   function reinstallAndRemoveTimer() {
 719     clearInterval(timerId);
 720     reinstall();
 721   }
 722
 723   timerId = setInterval(reinstall, 500);
 724   if (document.addEventListener)
 725     document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
 726   else
 727     window.onload = reinstallAndRemoveTimer;
 728 }
 729
 730 }
 731 asciidoc.install();
 732 /*]]>*/
 733 </script>
 734 </head>
 735 <body class="manpage">
 736 <div id="header">
 737 <h1>
 738 scalar(1) Manual Page
 739 </h1>
 740 <h2>NAME</h2>
 741 <div class="sectionbody">
 742 <p>scalar -
 743    A tool for managing large Git repositories
 744 </p>
 745 </div>
 746 </div>
 747 <div id="content">
 748 <div class="sect1">
 749 <h2 id="_synopsis">SYNOPSIS</h2>
 750 <div class="sectionbody">
 751 <div class="verseblock">
 752 <pre class="content">scalar clone [--single-branch] [--branch &lt;main-branch&gt;] [--full-clone]
 753         [--[no-]src] &lt;url&gt; [&lt;enlistment&gt;]
 754 scalar list
 755 scalar register [&lt;enlistment&gt;]
 756 scalar unregister [&lt;enlistment&gt;]
 757 scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [&lt;enlistment&gt;]
 758 scalar reconfigure [ --all | &lt;enlistment&gt; ]
 759 scalar diagnose [&lt;enlistment&gt;]
 760 scalar delete &lt;enlistment&gt;</pre>
 761 <div class="attribution">
 762 </div></div>
 763 </div>
 764 </div>
 765 <div class="sect1">
 766 <h2 id="_description">DESCRIPTION</h2>
 767 <div class="sectionbody">
 768 <div class="paragraph"><p>Scalar is a repository management tool that optimizes Git for use in large
 769 repositories. Scalar improves performance by configuring advanced Git settings,
 770 maintaining repositories in the background, and helping to reduce data sent
 771 across the network.</p></div>
 772 <div class="paragraph"><p>An important Scalar concept is the enlistment: this is the top-level directory
 773 of the project. It usually contains the subdirectory <code>src/</code> which is a Git
 774 worktree. This encourages the separation between tracked files (inside <code>src/</code>)
 775 and untracked files, such as build artifacts (outside <code>src/</code>). When registering
 776 an existing Git worktree with Scalar whose name is not <code>src</code>, the enlistment
 777 will be identical to the worktree.</p></div>
 778 <div class="paragraph"><p>The <code>scalar</code> command implements various subcommands, and different options
 779 depending on the subcommand. With the exception of <code>clone</code>, <code>list</code> and
 780 <code>reconfigure --all</code>, all subcommands expect to be run in an enlistment.</p></div>
 781 <div class="paragraph"><p>The following options can be specified <em>before</em> the subcommand:</p></div>
 782 <div class="dlist"><dl>
 783 <dt class="hdlist1">
 784 -C &lt;directory&gt;
 785 </dt>
 786 <dd>
 787 <p>
 788         Before running the subcommand, change the working directory. This
 789         option imitates the same option of <a href="git.html">git(1)</a>.
 790 </p>
 791 </dd>
 792 <dt class="hdlist1">
 793 -c &lt;key&gt;=&lt;value&gt;
 794 </dt>
 795 <dd>
 796 <p>
 797         For the duration of running the specified subcommand, configure this
 798         setting. This option imitates the same option of <a href="git.html">git(1)</a>.
 799 </p>
 800 </dd>
 801 </dl></div>
 802 </div>
 803 </div>
 804 <div class="sect1">
 805 <h2 id="_commands">COMMANDS</h2>
 806 <div class="sectionbody">
 807 <div class="sect2">
 808 <h3 id="_clone">Clone</h3>
 809 <div class="dlist"><dl>
 810 <dt class="hdlist1">
 811 clone [&lt;options&gt;] &lt;url&gt; [&lt;enlistment&gt;]
 812 </dt>
 813 <dd>
 814 <p>
 815         Clones the specified repository, similar to <a href="git-clone.html">git-clone(1)</a>. By
 816         default, only commit and tree objects are cloned. Once finished, the
 817         worktree is located at <code>&lt;enlistment&gt;/src</code>.
 818 </p>
 819 <div class="paragraph"><p>The sparse-checkout feature is enabled (except when run with <code>--full-clone</code>)
 820 and the only files present are those in the top-level directory. Use
 821 <code>git sparse-checkout set</code> to expand the set of directories you want to see,
 822 or <code>git sparse-checkout disable</code> to expand to all files (see
 823 <a href="git-sparse-checkout.html">git-sparse-checkout(1)</a> for more details). You can explore the
 824 subdirectories outside your sparse-checkout by using <code>git ls-tree
 825 HEAD[:&lt;directory&gt;]</code>.</p></div>
 826 </dd>
 827 <dt class="hdlist1">
 828 -b &lt;name&gt;
 829 </dt>
 830 <dt class="hdlist1">
 831 --branch &lt;name&gt;
 832 </dt>
 833 <dd>
 834 <p>
 835         Instead of checking out the branch pointed to by the cloned
 836         repository&#8217;s HEAD, check out the <code>&lt;name&gt;</code> branch instead.
 837 </p>
 838 </dd>
 839 <dt class="hdlist1">
 840 --[no-]single-branch
 841 </dt>
 842 <dd>
 843 <p>
 844         Clone only the history leading to the tip of a single branch, either
 845         specified by the <code>--branch</code> option or the primary branch remote&#8217;s
 846         <code>HEAD</code> points at.
 847 </p>
 848 <div class="paragraph"><p>Further fetches into the resulting repository will only update the
 849 remote-tracking branch for the branch this option was used for the initial
 850 cloning. If the HEAD at the remote did not point at any branch when
 851 <code>--single-branch</code> clone was made, no remote-tracking branch is created.</p></div>
 852 </dd>
 853 <dt class="hdlist1">
 854 --[no-]src
 855 </dt>
 856 <dd>
 857 <p>
 858         By default, <code>scalar clone</code> places the cloned repository within a
 859         <code>&lt;entlistment&gt;/src</code> directory. Use <code>--no-src</code> to place the cloned
 860         repository directly in the <code>&lt;enlistment&gt;</code> directory.
 861 </p>
 862 </dd>
 863 <dt class="hdlist1">
 864 --[no-]full-clone
 865 </dt>
 866 <dd>
 867 <p>
 868         A sparse-checkout is initialized by default. This behavior can be
 869         turned off via <code>--full-clone</code>.
 870 </p>
 871 </dd>
 872 </dl></div>
 873 </div>
 874 <div class="sect2">
 875 <h3 id="_list">List</h3>
 876 <div class="dlist"><dl>
 877 <dt class="hdlist1">
 878 list
 879 </dt>
 880 <dd>
 881 <p>
 882         List enlistments that are currently registered by Scalar. This
 883         subcommand does not need to be run inside an enlistment.
 884 </p>
 885 </dd>
 886 </dl></div>
 887 </div>
 888 <div class="sect2">
 889 <h3 id="_register">Register</h3>
 890 <div class="dlist"><dl>
 891 <dt class="hdlist1">
 892 register [&lt;enlistment&gt;]
 893 </dt>
 894 <dd>
 895 <p>
 896         Adds the enlistment&#8217;s repository to the list of registered repositories
 897         and starts background maintenance. If <code>&lt;enlistment&gt;</code> is not provided,
 898         then the enlistment associated with the current working directory is
 899         registered.
 900 </p>
 901 <div class="paragraph"><p>Note: when this subcommand is called in a worktree that is called <code>src/</code>, its
 902 parent directory is considered to be the Scalar enlistment. If the worktree is
 903 <em>not</em> called <code>src/</code>, it itself will be considered to be the Scalar enlistment.</p></div>
 904 </dd>
 905 </dl></div>
 906 </div>
 907 <div class="sect2">
 908 <h3 id="_unregister">Unregister</h3>
 909 <div class="dlist"><dl>
 910 <dt class="hdlist1">
 911 unregister [&lt;enlistment&gt;]
 912 </dt>
 913 <dd>
 914 <p>
 915         Remove the specified repository from the list of repositories
 916         registered with Scalar and stop the scheduled background maintenance.
 917 </p>
 918 </dd>
 919 </dl></div>
 920 </div>
 921 <div class="sect2">
 922 <h3 id="_run">Run</h3>
 923 <div class="dlist"><dl>
 924 <dt class="hdlist1">
 925 scalar run ( all | config | commit-graph | fetch | loose-objects | pack-files ) [&lt;enlistment&gt;]
 926 </dt>
 927 <dd>
 928 <p>
 929         Run the given maintenance task (or all tasks, if <code>all</code> was specified).
 930         Except for <code>all</code> and <code>config</code>, this subcommand simply hands off to
 931         <a href="git-maintenance.html">git-maintenance(1)</a> (mapping <code>fetch</code> to <code>prefetch</code> and
 932         <code>pack-files</code> to <code>incremental-repack</code>).
 933 </p>
 934 <div class="paragraph"><p>These tasks are run automatically as part of the scheduled maintenance,
 935 as soon as the repository is registered with Scalar. It should therefore
 936 not be necessary to run this subcommand manually.</p></div>
 937 <div class="paragraph"><p>The <code>config</code> task is specific to Scalar and configures all those
 938 opinionated default settings that make Git work more efficiently with
 939 large repositories. As this task is run as part of <code>scalar clone</code>
 940 automatically, explicit invocations of this task are rarely needed.</p></div>
 941 </dd>
 942 </dl></div>
 943 </div>
 944 <div class="sect2">
 945 <h3 id="_reconfigure">Reconfigure</h3>
 946 <div class="paragraph"><p>After a Scalar upgrade, or when the configuration of a Scalar enlistment
 947 was somehow corrupted or changed by mistake, this subcommand allows to
 948 reconfigure the enlistment.</p></div>
 949 <div class="paragraph"><p>With the <code>--all</code> option, all enlistments currently registered with Scalar
 950 will be reconfigured. Use this option after each Scalar upgrade.</p></div>
 951 </div>
 952 <div class="sect2">
 953 <h3 id="_diagnose">Diagnose</h3>
 954 <div class="dlist"><dl>
 955 <dt class="hdlist1">
 956 diagnose [&lt;enlistment&gt;]
 957 </dt>
 958 <dd>
 959 <p>
 960     When reporting issues with Scalar, it is often helpful to provide the
 961     information gathered by this command, including logs and certain
 962     statistics describing the data shape of the current enlistment.
 963 </p>
 964 <div class="paragraph"><p>The output of this command is a <code>.zip</code> file that is written into
 965 a directory adjacent to the worktree in the <code>src</code> directory.</p></div>
 966 </dd>
 967 </dl></div>
 968 </div>
 969 <div class="sect2">
 970 <h3 id="_delete">Delete</h3>
 971 <div class="dlist"><dl>
 972 <dt class="hdlist1">
 973 delete &lt;enlistment&gt;
 974 </dt>
 975 <dd>
 976 <p>
 977         This subcommand lets you delete an existing Scalar enlistment from your
 978         local file system, unregistering the repository.
 979 </p>
 980 </dd>
 981 </dl></div>
 982 </div>
 983 </div>
 984 </div>
 985 <div class="sect1">
 986 <h2 id="_see_also">SEE ALSO</h2>
 987 <div class="sectionbody">
 988 <div class="paragraph"><p><a href="git-clone.html">git-clone(1)</a>, <a href="git-maintenance.html">git-maintenance(1)</a>.</p></div>
 989 </div>
 990 </div>
 991 <div class="sect1">
 992 <h2 id="_git">GIT</h2>
 993 <div class="sectionbody">
 994 <div class="paragraph"><p>Part of the <a href="git.html">git(1)</a> suite</p></div>
 995 </div>
 996 </div>
 997 </div>
 998 <div id="footnotes"><hr /></div>
 999 <div id="footer">
1000 <div id="footer-text">
1001 Last updated
1002  2023-08-29 14:18:03 PDT
1003 </div>
1004 </div>
1005 </body>
1006 </html>