<!DOCTYPE html>
<html lang='en'>
<head>
<title>keyparser: Remove the restriction that a root can't be a leaf - ranger - mirror of ranger - a simple, vim-like file manager</title>
<meta name='generator' content='cgit 1.4.1-2-gfad0'/>
<meta name='robots' content='index, nofollow'/>
<link rel='stylesheet' type='text/css' href='/cgit.css'/>
<link rel='alternate' title='Atom feed' href='https://git.tilde.institute/akspecs/ranger/atom/test?h=v1.7.0' type='application/atom+xml'/>
<link rel='vcs-git' href='https://git.tilde.institute/akspecs/ranger' title='ranger Git repository'/>
</head>
<body>
<div id='cgit'><table id='header'>
<tr>
<td class='main'><a href='/'>index</a> : <a href='/akspecs/ranger/'>ranger</a></td><td class='form'><form method='get'>
<input type='hidden' name='id' value='895e04b312544515549fe953e0264d572837ae55'/><select name='h' onchange='this.form.submit();'>
<option value='e0c6b32d0db79f94b9c4315d75b01ab745c1a0ac'>this commit</option>
<optgroup label='branches'><option value='master'>master</option>
</optgroup></select> <input type='submit' value='switch'/></form></td></tr>
<tr><td class='sub'>mirror of ranger - a simple, vim-like file manager</td><td class='sub right'>akspecs &lt;akspecs@tilde.institute&gt;</td></tr></table>
<table class='tabs'><tr><td>
<a href='/akspecs/ranger/?h=v1.7.0'>summary</a> <a href='/akspecs/ranger/refs/?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>refs</a> <a href='/akspecs/ranger/log/test?h=v1.7.0'>log</a> <a href='/akspecs/ranger/tree/test?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>tree</a> <a class='active' href='/akspecs/ranger/commit/test?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>commit</a> <a href='/akspecs/ranger/diff/test?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>diff</a> <a href='/akspecs/ranger/stats/test?h=v1.7.0'>stats</a></td><td class='form'><form class='right' method='get' action='/akspecs/ranger/log/test'>
<input type='hidden' name='h' value='v1.7.0'/><input type='hidden' name='id' value='895e04b312544515549fe953e0264d572837ae55'/><select name='qt'>
<option value='grep'>log msg</option>
<option value='author'>author</option>
<option value='committer'>committer</option>
<option value='range'>range</option>
</select>
<input class='txt' type='search' size='10' name='q' value=''/>
<input type='submit' value='search'/>
</form>
</td></tr></table>
<div class='path'>path: <a href='/akspecs/ranger/commit/?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>root</a>/<a href='/akspecs/ranger/commit/test?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>test</a></div><div class='content'><div class='cgit-panel'><b>diff options</b><form method='get'><input type='hidden' name='h' value='v1.7.0'/><input type='hidden' name='id' value='895e04b312544515549fe953e0264d572837ae55'/><table><tr><td colspan='2'/></tr><tr><td class='label'>context:</td><td class='ctrl'><select name='context' onchange='this.form.submit();'><option value='1'>1</option><option value='2'>2</option><option value='3' selected='selected'>3</option><option value='4'>4</option><option value='5'>5</option><option value='6'>6</option><option value='7'>7</option><option value='8'>8</option><option value='9'>9</option><option value='10'>10</option><option value='15'>15</option><option value='20'>20</option><option value='25'>25</option><option value='30'>30</option><option value='35'>35</option><option value='40'>40</option></select></td></tr><tr><td class='label'>space:</td><td class='ctrl'><select name='ignorews' onchange='this.form.submit();'><option value='0' selected='selected'>include</option><option value='1'>ignore</option></select></td></tr><tr><td class='label'>mode:</td><td class='ctrl'><select name='dt' onchange='this.form.submit();'><option value='0' selected='selected'>unified</option><option value='1'>ssdiff</option><option value='2'>stat only</option></select></td></tr><tr><td/><td class='ctrl'><noscript><input type='submit' value='reload'/></noscript></td></tr></table></form></div><table summary='commit info' class='commit-info'>
<tr><th>author</th><td>hut &lt;hut@lavabit.com&gt;</td><td class='right'>2010-02-18 01:05:36 +0100</td></tr>
<tr><th>committer</th><td>hut &lt;hut@lavabit.com&gt;</td><td class='right'>2010-03-09 14:40:21 +0100</td></tr>
<tr><th>commit</th><td colspan='2' class='oid'><a href='/akspecs/ranger/commit/test?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>895e04b312544515549fe953e0264d572837ae55</a> (<a href='/akspecs/ranger/patch/test?id=895e04b312544515549fe953e0264d572837ae55'>patch</a>)</td></tr>
<tr><th>tree</th><td colspan='2' class='oid'><a href='/akspecs/ranger/tree/?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>49d3d9c4b4ed27dec4f23d11a0436fcb85dbdee4</a> /<a href='/akspecs/ranger/tree/test?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>test</a></td></tr>
<tr><th>parent</th><td colspan='2' class='oid'><a href='/akspecs/ranger/commit/test?h=v1.7.0&amp;id=e975b52f9e83bf2ca3fbb6cf066ccd662518a7df'>e975b52f9e83bf2ca3fbb6cf066ccd662518a7df</a> (<a href='/akspecs/ranger/diff/test?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55&amp;id2=e975b52f9e83bf2ca3fbb6cf066ccd662518a7df'>diff</a>)</td></tr><tr><th>download</th><td colspan='2' class='oid'><a href='/akspecs/ranger/snapshot/ranger-895e04b312544515549fe953e0264d572837ae55.tar.gz'>ranger-895e04b312544515549fe953e0264d572837ae55.tar.gz</a><br/></td></tr></table>
<div class='commit-subject'>keyparser: Remove the restriction that a root can't be a leaf</div><pre class='commit-msg'></pre><div class='diffstat-header'><a href='/akspecs/ranger/diff/?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>Diffstat</a> (limited to 'test')</div><table summary='diffstat' class='diffstat'><tr><td class='mode'>-rw-r--r--</td><td class='upd'><a href='/akspecs/ranger/diff/test/tc_newkeys.py?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>test/tc_newkeys.py</a></td><td class='right'>1</td><td class='graph'><table summary='file diffstat' width='1%'><tr><td class='add' style='width: 0.0%;'/><td class='rem' style='width: 100.0%;'/><td class='none' style='width: 0.0%;'/></tr></table></td></tr>
</table><div class='diffstat-summary'>1 files changed, 0 insertions, 1 deletions</div><table summary='diff' class='diff'><tr><td><pre><span class='head'>diff --git a/test/tc_newkeys.py b/test/tc_newkeys.py
index 10519dbf..df32c14a 100644
--- a/<a href='/akspecs/ranger/tree/test/tc_newkeys.py?h=v1.7.0&amp;id=e975b52f9e83bf2ca3fbb6cf066ccd662518a7df'>test/tc_newkeys.py</a>
+++ b/<a href='/akspecs/ranger/tree/test/tc_newkeys.py?h=v1.7.0&amp;id=895e04b312544515549fe953e0264d572837ae55'>test/tc_newkeys.py</a>
</span><span class='hunk'>@@ -233,7 +233,6 @@ def translate_keys(obj):</span>
<span class='ctx'> </span>
<span class='ctx'> class Tree(object):</span>
<span class='ctx'> 	def __init__(self, dictionary=None, parent=None, key=None):</span>
<span class='del'>-		assert dictionary is None or isinstance(dictionary, dict)</span>
<span class='ctx'> 		if dictionary is None:</span>
<span class='ctx'> 			self._tree = dict()</span>
<span class='ctx'> 		else:</span>
</pre></td></tr></table></div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.causal.agency/cgit-pink/about/'>cgit-pink 1.4.1-2-gfad0</a> (<a href='https://git-scm.com/'>git 2.36.2.497.gbbea4dcf42</a>) at 2025-07-17 02:22:23 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>
'>138</a>
<a id='n139' href='#n139'>139</a>
<a id='n140' href='#n140'>140</a>
<a id='n141' href='#n141'>141</a>
<a id='n142' href='#n142'>142</a>
<a id='n143' href='#n143'>143</a>
<a id='n144' href='#n144'>144</a>
<a id='n145' href='#n145'>145</a>
<a id='n146' href='#n146'>146</a>
<a id='n147' href='#n147'>147</a>
<a id='n148' href='#n148'>148</a>
<a id='n149' href='#n149'>149</a>
<a id='n150' href='#n150'>150</a>
<a id='n151' href='#n151'>151</a>
<a id='n152' href='#n152'>152</a>
<a id='n153' href='#n153'>153</a>
<a id='n154' href='#n154'>154</a>
<a id='n155' href='#n155'>155</a>
<a id='n156' href='#n156'>156</a>
<a id='n157' href='#n157'>157</a>
<a id='n158' href='#n158'>158</a>
<a id='n159' href='#n159'>159</a>
<a id='n160' href='#n160'>160</a>
<a id='n161' href='#n161'>161</a>
<a id='n162' href='#n162'>162</a>
<a id='n163' href='#n163'>163</a>
<a id='n164' href='#n164'>164</a>
<a id='n165' href='#n165'>165</a>
<a id='n166' href='#n166'>166</a>
<a id='n167' href='#n167'>167</a>
<a id='n168' href='#n168'>168</a>
<a id='n169' href='#n169'>169</a>
<a id='n170' href='#n170'>170</a>
<a id='n171' href='#n171'>171</a>
<a id='n172' href='#n172'>172</a>
<a id='n173' href='#n173'>173</a>
<a id='n174' href='#n174'>174</a>
<a id='n175' href='#n175'>175</a>
<a id='n176' href='#n176'>176</a>
<a id='n177' href='#n177'>177</a>
<a id='n178' href='#n178'>178</a>
<a id='n179' href='#n179'>179</a>
<a id='n180' href='#n180'>180</a>
<a id='n181' href='#n181'>181</a>
<a id='n182' href='#n182'>182</a>
<a id='n183' href='#n183'>183</a>
<a id='n184' href='#n184'>184</a>
<a id='n185' href='#n185'>185</a>
<a id='n186' href='#n186'>186</a>
<a id='n187' href='#n187'>187</a>
<a id='n188' href='#n188'>188</a>
<a id='n189' href='#n189'>189</a>
<a id='n190' href='#n190'>190</a>
<a id='n191' href='#n191'>191</a>
<a id='n192' href='#n192'>192</a>
<a id='n193' href='#n193'>193</a>
<a id='n194' href='#n194'>194</a>
<a id='n195' href='#n195'>195</a>
<a id='n196' href='#n196'>196</a>
<a id='n197' href='#n197'>197</a>
<a id='n198' href='#n198'>198</a>
<a id='n199' href='#n199'>199</a>
<a id='n200' href='#n200'>200</a>
<a id='n201' href='#n201'>201</a>
<a id='n202' href='#n202'>202</a>
<a id='n203' href='#n203'>203</a>
<a id='n204' href='#n204'>204</a>
<a id='n205' href='#n205'>205</a>
<a id='n206' href='#n206'>206</a>
<a id='n207' href='#n207'>207</a>
<a id='n208' href='#n208'>208</a>
<a id='n209' href='#n209'>209</a>
<a id='n210' href='#n210'>210</a>
<a id='n211' href='#n211'>211</a>
<a id='n212' href='#n212'>212</a>
<a id='n213' href='#n213'>213</a>
<a id='n214' href='#n214'>214</a>
<a id='n215' href='#n215'>215</a>
<a id='n216' href='#n216'>216</a>
<a id='n217' href='#n217'>217</a>
<a id='n218' href='#n218'>218</a>
<a id='n219' href='#n219'>219</a>
<a id='n220' href='#n220'>220</a>
<a id='n221' href='#n221'>221</a>
<a id='n222' href='#n222'>222</a>
<a id='n223' href='#n223'>223</a>
<a id='n224' href='#n224'>224</a>
<a id='n225' href='#n225'>225</a>
<a id='n226' href='#n226'>226</a>
<a id='n227' href='#n227'>227</a>
<a id='n228' href='#n228'>228</a>
<a id='n229' href='#n229'>229</a>
<a id='n230' href='#n230'>230</a>
<a id='n231' href='#n231'>231</a>
<a id='n232' href='#n232'>232</a>
<a id='n233' href='#n233'>233</a>
<a id='n234' href='#n234'>234</a>
<a id='n235' href='#n235'>235</a>
<a id='n236' href='#n236'>236</a>
<a id='n237' href='#n237'>237</a>
<a id='n238' href='#n238'>238</a>
<a id='n239' href='#n239'>239</a>
<a id='n240' href='#n240'>240</a>
<a id='n241' href='#n241'>241</a>
<a id='n242' href='#n242'>242</a>
<a id='n243' href='#n243'>243</a>
<a id='n244' href='#n244'>244</a>
<a id='n245' href='#n245'>245</a>
<a id='n246' href='#n246'>246</a>
<a id='n247' href='#n247'>247</a>
<a id='n248' href='#n248'>248</a>
<a id='n249' href='#n249'>249</a>
<a id='n250' href='#n250'>250</a>
<a id='n251' href='#n251'>251</a>
<a id='n252' href='#n252'>252</a>
<a id='n253' href='#n253'>253</a>
<a id='n254' href='#n254'>254</a>
<a id='n255' href='#n255'>255</a>
<a id='n256' href='#n256'>256</a>
<a id='n257' href='#n257'>257</a>
<a id='n258' href='#n258'>258</a>
<a id='n259' href='#n259'>259</a>
<a id='n260' href='#n260'>260</a>
<a id='n261' href='#n261'>261</a>
<a id='n262' href='#n262'>262</a>
<a id='n263' href='#n263'>263</a>
<a id='n264' href='#n264'>264</a>
<a id='n265' href='#n265'>265</a>
<a id='n266' href='#n266'>266</a>
<a id='n267' href='#n267'>267</a>
<a id='n268' href='#n268'>268</a>
<a id='n269' href='#n269'>269</a>
<a id='n270' href='#n270'>270</a>
<a id='n271' href='#n271'>271</a>
<a id='n272' href='#n272'>272</a>
<a id='n273' href='#n273'>273</a>
<a id='n274' href='#n274'>274</a>
<a id='n275' href='#n275'>275</a>
<a id='n276' href='#n276'>276</a>
<a id='n277' href='#n277'>277</a>
<a id='n278' href='#n278'>278</a>
<a id='n279' href='#n279'>279</a>
<a id='n280' href='#n280'>280</a>
<a id='n281' href='#n281'>281</a>
<a id='n282' href='#n282'>282</a>
<a id='n283' href='#n283'>283</a>
<a id='n284' href='#n284'>284</a>
<a id='n285' href='#n285'>285</a>
<a id='n286' href='#n286'>286</a>
<a id='n287' href='#n287'>287</a>
<a id='n288' href='#n288'>288</a>
<a id='n289' href='#n289'>289</a>
<a id='n290' href='#n290'>290</a>
<a id='n291' href='#n291'>291</a>
<a id='n292' href='#n292'>292</a>
<a id='n293' href='#n293'>293</a>
<a id='n294' href='#n294'>294</a>
<a id='n295' href='#n295'>295</a>
<a id='n296' href='#n296'>296</a>
<a id='n297' href='#n297'>297</a>
<a id='n298' href='#n298'>298</a>
<a id='n299' href='#n299'>299</a>
<a id='n300' href='#n300'>300</a>
<a id='n301' href='#n301'>301</a>
<a id='n302' href='#n302'>302</a>
<a id='n303' href='#n303'>303</a>
<a id='n304' href='#n304'>304</a>
<a id='n305' href='#n305'>305</a>
<a id='n306' href='#n306'>306</a>
</pre></td>
<td class='lines'><pre><code><style>pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #888888 } /* Comment */
.highlight .err { color: #a61717; background-color: #e3d2d2 } /* Error */
.highlight .k { color: #008800; font-weight: bold } /* Keyword */
.highlight .ch { color: #888888 } /* Comment.Hashbang */
.highlight .cm { color: #888888 } /* Comment.Multiline */
.highlight .cp { color: #cc0000; font-weight: bold } /* Comment.Preproc */
.highlight .cpf { color: #888888 } /* Comment.PreprocFile */
.highlight .c1 { color: #888888 } /* Comment.Single */
.highlight .cs { color: #cc0000; font-weight: bold; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #aa0000 } /* Generic.Error */
.highlight .gh { color: #333333 } /* Generic.Heading */
.highlight .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #555555 } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #666666 } /* Generic.Subheading */
.highlight .gt { color: #aa0000 } /* Generic.Traceback */
.highlight .kc { color: #008800; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008800; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008800; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008800 } /* Keyword.Pseudo */
.highlight .kr { color: #008800; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #888888; font-weight: bold } /* Keyword.Type */
.highlight .m { color: #0000DD; font-weight: bold } /* Literal.Number */
.highlight .s { color: #dd2200; background-color: #fff0f0 } /* Literal.String */
.highlight .na { color: #336699 } /* Name.Attribute */
.highlight .nb { color: #003388 } /* Name.Builtin */
.highlight .nc { color: #bb0066; font-weight: bold } /* Name.Class */
.highlight .no { color: #003366; font-weight: bold } /* Name.Constant */
.highlight .nd { color: #555555 } /* Name.Decorator */
.highlight .ne { color: #bb0066; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #0066bb; font-weight: bold } /* Name.Function */
.highlight .nl { color: #336699; font-style: italic } /* Name.Label */
.highlight .nn { color: #bb0066; font-weight: bold } /* Name.Namespace */
.highlight .py { color: #336699; font-weight: bold } /* Name.Property */
.highlight .nt { color: #bb0066; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #336699 } /* Name.Variable */
.highlight .ow { color: #008800 } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #0000DD; font-weight: bold } /* Literal.Number.Bin */
.highlight .mf { color: #0000DD; font-weight: bold } /* Literal.Number.Float */
.highlight .mh { color: #0000DD; font-weight: bold } /* Literal.Number.Hex */
.highlight .mi { color: #0000DD; font-weight: bold } /* Literal.Number.Integer */
.highlight .mo { color: #0000DD; font-weight: bold } /* Literal.Number.Oct */
.highlight .sa { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Affix */
.highlight .sb { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Backtick */
.highlight .sc { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Char */
.highlight .dl { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Delimiter */
.highlight .sd { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Doc */
.highlight .s2 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Double */
.highlight .se { color: #0044dd; background-color: #fff0f0 } /* Literal.String.Escape */
.highlight .sh { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Heredoc */
.highlight .si { color: #3333bb; background-color: #fff0f0 } /* Literal.String.Interpol */
.highlight .sx { color: #22bb22; background-color: #f0fff0 } /* Literal.String.Other */
.highlight .sr { color: #008800; background-color: #fff0ff } /* Literal.String.Regex */
.highlight .s1 { color: #dd2200; background-color: #fff0f0 } /* Literal.String.Single */
.highlight .ss { color: #aa6600; background-color: #fff0f0 } /* Literal.String.Symbol */
.highlight .bp { color: #003388 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #0066bb; font-weight: bold } /* Name.Function.Magic */
.highlight .vc { color: #336699 } /* Name.Variable.Class */
.highlight .vg { color: #dd7700 } /* Name.Variable.Global */
.highlight .vi { color: #3333bb } /* Name.Variable.Instance */
.highlight .vm { color: #336699 } /* Name.Variable.Magic */
.highlight .il { color: #0000DD; font-weight: bold } /* Literal.Number.Integer.Long */</style><div class="highlight"><pre><span></span><span class="k">\input</span> texinfo
@setfilename dscip.info
@settitle Dead Simple Continuous Integration POSIX

@copying
Dead Simple Continuous Integration POSIX Manual by Charadon
(DSCIP Manual for short.)

To the extent possible under law, the person who associated CC0 with
DSCIP Manual has waived all copyright and related or neighboring rights
to DSCIP Manual.

You should have received a copy of the CC0 legalcode along with this
work.  If not, see &lt;http://creativecommons.org/publicdomain/zero/1.0/&gt;.
@end copying

@contents

@node Top
@top DSCIP Manual

This is the manual for the Dead Simple Continuous Integration POSIX program.

@menu
* Installing::
* Using::
* Quirks::

* Index::
@end menu

@node Installing
@chapter Installing
@cindex Installing
	Details on installing DSCIP onto various systems.
	@node Downloading
	@section Downloading
	@cindex Downloading
		Currently, the upstream repo for DSCIP is located at this
		@url<span class="nb">{</span>https://www.opencode.net/charadon/dscip, Git Repo<span class="nb">}</span>. If your OS
		doesn&#39;t have DSCIP packaged, you can download the @command<span class="nb">{</span>setup.sh<span class="nb">}</span>
		from the releases page, and use that to install dscip. Alternatively,
		you can clone the git repo into whatever directory you want.
	@node Unix
	@section Unix
		@cindex Installing on Unix
		In this section, Unix refers to systems that are similar in nature to the
		old System V Unix or is POSIX in nature. This would include: Linux, BSD,
		Mac, Haiku, and Illumos.@*@*
		The instructions will pretty much be the same for all systems.

		@node As a Package
		@subsection As a Package
		@cindex Unix: Installing Packaged DSCIP
			If your host OS packaged DSCIP correctly according to 
			Packaging (@xref<span class="nb">{</span>Packaging<span class="nb">}</span>), these instructions should work.

			@enumerate
			@item
			Run @command<span class="nb">{</span>setup-dscip<span class="nb">}</span> in the terminal. See @command<span class="nb">{</span>setup-dscip
			-h<span class="nb">}</span> for more details.
			@item
			Add the new script as a cronjob or daemon. See your OS&#39;s
			manual for instructions on how to do so.
			@end enumerate
			
			And that&#39;s it! You&#39;re ready to go!

		@node Manually
		@subsection Manually
		@cindex Unix: Install Manually
			While not as simple as if it was packaged. The process is still not
			that hard.
			@enumerate
			@item
			Run @command<span class="nb">{</span>setup.sh<span class="nb">}</span>. See @command<span class="nb">{</span>setup.sh -h<span class="nb">}</span> for more
			details.
			@item
			Add the new script as a cronjob or daemon. See your OS&#39;s manual
			for instructions on how to do so.
			@end enumerate
			And that&#39;s it! You&#39;re ready to go!

	@node Windows
	@section Windows
	@cindex Installing on Windows
		Windows is a different beast from Unix. So it warrants it&#39;s own dedicated
		section.
		@node MSYS2 (Recommended)
		@subsection MSYS2 (Recommended)
		@cindex Windows: Installing on MSYS2
			@enumerate
			@item
			Install @url<span class="nb">{</span>https://www.msys2.org, MSYS2<span class="nb">}</span> in whatever way you want. I recommend using
			@url<span class="nb">{</span>https://scoop.sh, Scoop<span class="nb">}</span>.
			@item
			Once MSYS2 is installed, run setup.sh (@command<span class="nb">{</span>setup.sh -h<span class="nb">}</span> for
			more info.).
			@item
			Next, we&#39;ll need to set it up as a service since Windows doesn&#39;t
			really have cronjobs. I recommend using @url<span class="nb">{</span>https://nssm.cc, NSSM<span class="nb">}</span>
			to create a service for Windows.
			@item
			Edit config.sh and set @env<span class="nb">{</span>DSCIP<span class="nb">_</span>DAEMON<span class="nb">}</span> to true, and set
			@env<span class="nb">{</span>DSCIP<span class="nb">_</span>DAEMON<span class="nb">_</span>FORK<span class="nb">}</span> to false.
			@item
			Next, create a batch/powershell script to launch MSYS2 to run the
			dscip script. Here&#39;s an example batch script:
			@example
set MSYSTEM=MINGW64
&quot;C:<span class="k">\Users\builder</span>.DESKTOP-U8KQJI1<span class="k">\scoop\apps\msys</span>2<span class="k">\current\usr\bin\bash</span>&quot; -l -c &quot;path/to/dscip&quot;
			@end example
			@item
			Next, run @command<span class="nb">{</span>nssm install &lt;name of service&gt;<span class="nb">}</span> and set follow
			it&#39;s instructions. You can also use
			@url<span class="nb">{</span>https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/sc-create,
			sc.exe<span class="nb">}</span> if you&#39;d rather not use NSSM.
			@item
			Then you just open services.msc and run it, or use @command<span class="nb">{</span>nssm
			start name-of-service<span class="nb">}</span>, if you went with NSSM.
			
			@end enumerate
	
		@node Only Bash
		@subsection Bash
		@cindex Windows: Installing with only Bash
			The easiest way to get Bash on Windows is to install git, so we&#39;ll
			be assuming that path.
			@enumerate
			@item
			Install @url<span class="nb">{</span>https://gitforwindows.org/, Git for Windows<span class="nb">}</span>, I recommend using @url<span class="nb">{</span>https://scoop.sh,
			Scoop<span class="nb">}</span>.
			@item
			Once Git is installed, you should be able to run @command<span class="nb">{</span>bash<span class="nb">}</span> from
			the command prompt or powershell. Once in Bash, run setup.sh
			(@command<span class="nb">{</span>setup.sh -h<span class="nb">}</span> for more info.) and install dscip.
			@item
			Once installed, you&#39;ll need to set up a service for it. I recommend
			using @url<span class="nb">{</span>https://nssm.cc, NSSM<span class="nb">}</span> for an easier time.
			@item
			Open config.sh and change @env<span class="nb">{</span>DSCIP<span class="nb">_</span>DAEMON<span class="nb">}</span> to true, and set
			@env<span class="nb">{</span>DSCIP<span class="nb">_</span>DAEMON<span class="nb">_</span>FORK<span class="nb">}</span> to false.
			@item
			Create a Batch or Powershell script, here&#39;s an example batch script:
			@*
			@example
			bash &quot;C:<span class="k">\path\to\dscip</span>&quot;
			@end example
			@item
			Once the script is done being made, you can use NSSM to create the
			service, or
			@url<span class="nb">{</span>https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/sc-create,
			sc.exe<span class="nb">}</span>.
			@item
			Now just open services.msc or @command<span class="nb">{</span>nssm start &lt;name-of-service&gt;<span class="nb">}</span>
			to start it.
			@end enumerate
		
	
	@node Packaging
	@section Packaging
	@cindex Packaging
		Packaging is pretty easy, just run @command<span class="nb">{</span>make install<span class="nb">}</span> and it&#39;ll do
		everything for you. You can use environment variables to change where
		certain things go though.
		@enumerate
		@item
		@env<span class="nb">{</span>PREFIX<span class="nb">}</span>: This specifies where on the system everything will go. By
		default it&#39;s /usr/local.
		@item
		@env<span class="nb">{</span>BINDIR<span class="nb">}</span>: The directory to install setup.sh to. When installed, it
		will change it&#39;s name to @command<span class="nb">{</span>setup-dscip<span class="nb">}</span>.
		@item
		@env<span class="nb">{</span>INFODIR<span class="nb">}</span>: The directory to install the manual. Default is
		@env<span class="nb">{</span>PREFIX<span class="nb">}</span>/share/info.
		@end enumerate
		@noindent
		This is the general layout that the Makefile defaults to:
		@example
├── bin
│   └── setup-dscip (setup.sh)
└── share
    ├── charadon
    │   └── dscip
    │       ├── build.sh
    │       ├── config.sh
    │       ├── dscip
    │       ├── failed.sh
    │       ├── post.sh
    │       └── pre.sh
    └── info
        └── dscip.info.gz
		@end example
		@*
		@noindent
		You&#39;ll note two things:
		@enumerate
		@item
		@command<span class="nb">{</span>update.sh<span class="nb">}</span> is not included. This is mainly mean&#39;t for non-package
		installs. Such as direct @command<span class="nb">{</span>git<span class="nb">}</span> clones, or using the
		@command<span class="nb">{</span>setup.sh<span class="nb">}</span> script on it&#39;s own.
		@item
		@env<span class="nb">{</span>SCRIPT<span class="nb">_</span>DIR<span class="nb">}</span> cannot be changed from it&#39;s default of
		<span class="s">$</span><span class="nb">PREFIX</span><span class="o">/</span><span class="nb">share</span><span class="o">/</span><span class="nb">charadon</span><span class="o">/</span><span class="nb">dscip. This is because the @command{setup.sh}</span>
<span class="nb">		script relies on the scripts being there to symlink to them.</span>
<span class="nb">		@end enumerate</span>

<span class="nb">	@node Using Templates</span>
<span class="nb">	@section Using Templates</span>
<span class="nb">	@cindex Using Templates</span>
<span class="nb">		Templates are an easy way to quickly get a DSCIP instance up and</span>
<span class="nb">		running. Since most developers tend to have all their projects build</span>
<span class="nb">		almost the exact same way, you can easily create a git repo with your DSCIP</span>
<span class="nb">		scripts and have the setup script copy them over. You can point to the</span>
<span class="nb">		directory containing your templates by using the @option{</span><span class="o">-</span><span class="nb">t} argument with</span>
<span class="nb">		setup.sh. You find find an example of templates here at my</span>
<span class="nb">		@url{https:</span><span class="o">//</span><span class="nb">www.opencode.net</span><span class="o">/</span><span class="nb">charadon</span><span class="o">/</span><span class="nb">my</span><span class="o">-</span><span class="nb">dscip</span><span class="o">-</span><span class="nb">templates</span><span class="o">-</span><span class="nb">v</span><span class="m">1</span><span class="nb">, Git Repo}</span>
<span class="nb">		</span>
<span class="nb">	</span>

<span class="nb">@node Using</span>
<span class="nb">@chapter Using</span>
<span class="nb">@cindex Using</span>
<span class="nb">	This chapter goes over how to actually use DSCIP.</span>
<span class="nb">	@node Basic Variables</span>
<span class="nb">	@section Basic Variables</span>
<span class="nb">	@cindex Basic Variables</span>
<span class="nb">		This section goes over variables that you can safely modify in</span>
<span class="nb">		config.sh.</span>
<span class="nb">		@subsection DSCIP_GITREPO</span>
<span class="nb">		@cindex Basic Variables: DSCIP_GITREPO</span>
<span class="nb">			This is the variable that determines what git repo DSCIP clones into</span>
<span class="nb">			wrkdir.</span>
<span class="nb">		@subsection DSCIP_NAME</span>
<span class="nb">		@cindex Basic Variables: DSCIP_NAME</span>
<span class="nb">			This variable determines the name of the program that&#39;s being build.</span>
<span class="nb">			Mostly for use with the @command{post.sh} and @command{failed.sh}</span>
<span class="nb">			scripts when publishing artifacts.</span>
<span class="nb">		@subsection DSCIP_BRANCH</span>
<span class="nb">		@cindex Basic Variables: DSCIP_BRANCH</span>
<span class="nb">			This variable tells DSCIP which branch to clone. This is useful if</span>
<span class="nb">			you	develop in a branch other than master.</span>
<span class="nb">		@subsection DSCIP_DAEMON</span>
<span class="nb">		@cindex Basic Variables: DSCIP_DAEMON</span>
<span class="nb">			This variable will tell DSCIP to not close, but rather stay open and</span>
<span class="nb">			just sleep before re</span><span class="o">-</span><span class="nb">running itself. Useful for Windows, if you</span>
<span class="nb">			want DSCIP to run in shorter time periods than </span><span class="m">60</span><span class="nb"> seconds, or use</span>
<span class="nb">			special features that your OS&#39;s init system gives.</span>
<span class="nb">		@subsection DSCIP_DAEMON_FORK</span>
<span class="nb">		@cindex Basic Variables: DSCIP_DAEMON_FORK</span>
<span class="nb">			This variable tells DSCIP if it should run itself in the background.</span>
<span class="nb">			Some init systems prefer one or the other, so consult your OS&#39;s</span>
<span class="nb">			documentation.</span>
<span class="nb">		@subsection DSCIP_SLEEP</span>
<span class="nb">		@cindex Basic Variables: DSCIP_SLEEP</span>
<span class="nb">			When in daemon mode, this controls how long DSCIP should wait</span>
<span class="nb">			between attempted builds before checking for a new commit and</span>
<span class="nb">			building if one exists.</span>
<span class="nb">		@subsection DSCIP_OUTPUT_TO</span>
<span class="nb">		@cindex Basic Variables: DSCIP_OUTPUT_TO</span>
<span class="nb">			This variable tells DSCIP where to put logs. By default it puts all</span>
<span class="nb">			output into output.txt. This is useful if, for example, you&#39;re</span>
<span class="nb">			running DSCIP in daemon mode, and need to store logs somewhere else.</span>
<span class="nb">	@node Advanced Variables</span>
<span class="nb">	@section Advanced Variables</span>
<span class="nb">	@cindex Advanced Variables</span>
<span class="nb">		These are variables you should only change if you absolutely need to</span><span class="o">!</span>
<span class="nb">		@subsection DSCIP_GITMODE</span>
<span class="nb">		@cindex Advanced Variables: DSCIP_GITMODE</span>
<span class="nb">			This tells DSCIP to, rather than delete the wrkdir and get a fresh</span>
<span class="nb">			clone, to just pull changes. This is really only useful in</span>
<span class="nb">			situations where you have limited bandwidth.</span>
<span class="nb">		@subsection WORKING_DIRECTORY</span>
<span class="nb">		@cindex Advanced Variables: WORKING_DIRECTORY</span>
<span class="nb">			This should probably never be changed. The only situation that</span>
<span class="nb">			</span><span class="o">*</span><span class="nb">might</span><span class="o">*</span><span class="nb"> warrant changing it, is in a very restricted environment</span>
<span class="nb">			where it </span><span class="o">*</span><span class="nb">has</span><span class="o">*</span><span class="nb"> to run in a specific place.</span>
<span class="nb">		@subsection DSCIP_@{PRE,BUILD,POST,FAILED@}_CMD</span>
<span class="nb">		@cindex Advanced Variables: DSCIP_@{PRE,BUILD,POST,FAILED@}_CMD</span>
<span class="nb">			These variables tell DSCIP where to find their respective scripts. Like</span>
<span class="nb">			WORKING_DIRECTORY, this really shouldn&#39;t be changed and is really</span>
<span class="nb">			only useful in situations that are very restrictive.</span>
<span class="nb">		@subsection DSCIP_DISREGARD_COMMIT_CHECK</span>
<span class="nb">		@cindex Advanced Variables: DSCIP_DISREGARD_COMMIT_CHECK</span>
<span class="nb">			This variable tells DSCIP to ignore the commit check and just keep</span>
<span class="nb">			rebuilding. This is useful for seeing if old</span><span class="o">/</span><span class="nb">unmaintained software</span>
<span class="nb">			will still build on modern systems. But other than that, should be</span>
<span class="nb">			left off.</span>
<span class="nb">		@subsection DSCIP_AUTO_UPDATE</span>
<span class="nb">		@cindex Advanced Variables: DSCIP_AUTO_UPDATE</span>
<span class="nb">			This variable tells DSCIP to run @command{update.sh}, and then run a</span>
<span class="nb">			checksum on itself. If it&#39;s different from when it first launched,</span>
<span class="nb">			It&#39;ll re</span><span class="o">-</span><span class="nb">run itself. This is useful for manual installations.</span>

<span class="nb">@node Quirks</span>
<span class="nb">@chapter Quirks</span>
<span class="nb">@cindex Quirks</span>
<span class="nb">	This chapter goes over various quirks that have been discovered with DSCIP.</span>
<span class="nb">	None so far...</span>
<span class="nb">	</span>

<span class="nb">@node Index</span>
<span class="nb">@unnumbered Index</span>
<span class="nb">@printindex cp</span>

<span class="nb">@bye</span>
</pre></div>
</code></pre></td></tr></table>
</div> <!-- class=content -->
<div class='footer'>generated by <a href='https://git.causal.agency/cgit-pink/about/'>cgit-pink 1.4.1-2-gfad0</a> (<a href='https://git-scm.com/'>git 2.36.2.497.gbbea4dcf42</a>) at 2025-07-17 02:22:24 +0000</div>
</div> <!-- id=cgit -->
</body>
</html>
