GitHub/SwiftShell
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation.

Browse Source
This commit is contained in:
Kare Morstol
2018-03-04 17:25:54 +01:00
parent a7c41d63ef
commit 1bd7fd623c
56 changed files with 81 additions and 139 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Classes.html
+1 -1
View File
@@ -356,7 +356,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Classes/AsyncCommand.html
+7 -2
View File
@@ -314,6 +314,11 @@
<div class="pointer"></div>
<div class="abstract">
<p>Wait for this command to finish.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Will hang if the unread output of either standard output or standard error is larger than 64KB (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, read all the output first, even if you&rsquo;re not going to use it.
</div>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code>CommandError.returnedErrorCode(command: String, errorcode: Int)</code> if the exit code is anything but 0.
@@ -331,7 +336,7 @@
</div>
<div>
<h4>Return Value</h4>
<p>itself</p>
<p>self</p>
</div>
</section>
</div>
@@ -418,7 +423,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Classes/FileHandleStream.html
+1 -1
View File
@@ -278,7 +278,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Classes/MainContext.html
+1 -1
View File
@@ -459,7 +459,7 @@ It lies in the user&rsquo;s temporary directory and will be automatically delete
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Classes/RunOutput.html
+5 -5
View File
@@ -232,14 +232,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Standard output, trimmed for whitespace and newline if it is single-line.</p>
<p>Standard output, trimmed of whitespace and newline if it is single-line.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stdout</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">RunOutput</span><span class="o">.</span><span class="nf">cleanUpOutput</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="nf">read</span><span class="p">())</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stdout</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span></code></pre>
</div>
</div>
@@ -259,14 +259,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Standard error, trimmed for whitespace and newline if it is single-line.</p>
<p>Standard error, trimmed of whitespace and newline if it is single-line.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stderror</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">RunOutput</span><span class="o">.</span><span class="nf">cleanUpOutput</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">stderror</span><span class="o">.</span><span class="nf">read</span><span class="p">())</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stderror</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span></code></pre>
</div>
</div>
@@ -394,7 +394,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Classes/StdoutStream.html
+1 -1
View File
@@ -330,7 +330,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Enums.html
+1 -1
View File
@@ -257,7 +257,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Enums/CommandError.html
+1 -1
View File
@@ -316,7 +316,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Enums/FileError.html
+1 -1
View File
@@ -285,7 +285,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Extensions.html
+1 -1
View File
@@ -321,7 +321,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Extensions/FileHandle.html
+1 -1
View File
@@ -209,7 +209,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Extensions/LazyCollectionProtocol.html
+1 -1
View File
@@ -257,7 +257,7 @@ a separator, should empty slices be emitted? Defaults to false.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Extensions/Process.html
+1 -1
View File
@@ -254,7 +254,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Extensions/String.html
+1 -1
View File
@@ -255,7 +255,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Functions.html
+1 -15
View File
@@ -206,13 +206,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a bash shell command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -544,13 +537,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -954,7 +940,7 @@ If the file already exists and overwrite=false, the writing will begin at the en
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Global Variables.html
+1 -1
View File
@@ -248,7 +248,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Protocols.html
+1 -1
View File
@@ -336,7 +336,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Protocols/CommandRunning.html
+2 -16
View File
@@ -248,13 +248,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a bash shell command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -427,13 +420,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -513,7 +499,7 @@
<p>Run executable and return before it is finished.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
will crash if ‘executable’ could not be launched.
Will crash if ‘executable’ could not be launched.
</div>
@@ -641,7 +627,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Protocols/Context.html
+1 -1
View File
@@ -369,7 +369,7 @@ separate process and changing the directory there will not affect the rest of th
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Protocols/ReadableStream.html
+1 -1
View File
@@ -591,7 +591,7 @@ the handler, it may be called once when stream is closed and empty.
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Protocols/WritableStream.html
+1 -1
View File
@@ -431,7 +431,7 @@ Works exactly the same way as <code>print</code> from Swift&rsquo;s standard lib
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Structs.html
+1 -1
View File
@@ -282,7 +282,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Structs/CustomContext.html
+1 -1
View File
@@ -390,7 +390,7 @@ currentdirectory is the current working directory.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Structs/LazySplitSequence.html
+1 -1
View File
@@ -378,7 +378,7 @@ a separator, should empty slices be emitted? Defaults to false.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Structs/PartialSourceLazySplitSequence.html
+1 -1
View File
@@ -285,7 +285,7 @@ or nil if there are no more collections.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Classes.html
+1 -1
View File
@@ -356,7 +356,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Classes/AsyncCommand.html
+7 -2
View File
@@ -314,6 +314,11 @@
<div class="pointer"></div>
<div class="abstract">
<p>Wait for this command to finish.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
Will hang if the unread output of either standard output or standard error is larger than 64KB (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, read all the output first, even if you&rsquo;re not going to use it.
</div>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code>CommandError.returnedErrorCode(command: String, errorcode: Int)</code> if the exit code is anything but 0.
@@ -331,7 +336,7 @@
</div>
<div>
<h4>Return Value</h4>
<p>itself</p>
<p>self</p>
</div>
</section>
</div>
@@ -418,7 +423,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Classes/FileHandleStream.html
+1 -1
View File
@@ -278,7 +278,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Classes/MainContext.html
+1 -1
View File
@@ -459,7 +459,7 @@ It lies in the user&rsquo;s temporary directory and will be automatically delete
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Classes/RunOutput.html
+5 -5
View File
@@ -232,14 +232,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Standard output, trimmed for whitespace and newline if it is single-line.</p>
<p>Standard output, trimmed of whitespace and newline if it is single-line.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stdout</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">RunOutput</span><span class="o">.</span><span class="nf">cleanUpOutput</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="nf">read</span><span class="p">())</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stdout</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span></code></pre>
</div>
</div>
@@ -259,14 +259,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Standard error, trimmed for whitespace and newline if it is single-line.</p>
<p>Standard error, trimmed of whitespace and newline if it is single-line.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stderror</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">RunOutput</span><span class="o">.</span><span class="nf">cleanUpOutput</span><span class="p">(</span><span class="k">self</span><span class="o">.</span><span class="n">output</span><span class="o">.</span><span class="n">stderror</span><span class="o">.</span><span class="nf">read</span><span class="p">())</span></code></pre>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">private(set)</span> <span class="kd">lazy</span> <span class="k">var</span> <span class="nv">stderror</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span></code></pre>
</div>
</div>
@@ -394,7 +394,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Classes/StdoutStream.html
+1 -1
View File
@@ -330,7 +330,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Enums.html
+1 -1
View File
@@ -257,7 +257,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Enums/CommandError.html
+1 -1
View File
@@ -316,7 +316,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Enums/FileError.html
+1 -1
View File
@@ -285,7 +285,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Extensions.html
+1 -1
View File
@@ -321,7 +321,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Extensions/FileHandle.html
+1 -1
View File
@@ -209,7 +209,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Extensions/LazyCollectionProtocol.html
+1 -1
View File
@@ -257,7 +257,7 @@ a separator, should empty slices be emitted? Defaults to false.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Extensions/Process.html
+1 -1
View File
@@ -254,7 +254,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Extensions/String.html
+1 -1
View File
@@ -255,7 +255,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Functions.html
+1 -15
View File
@@ -206,13 +206,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a bash shell command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -544,13 +537,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -954,7 +940,7 @@ If the file already exists and overwrite=false, the writing will begin at the en
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Global Variables.html
+1 -1
View File
@@ -248,7 +248,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Protocols.html
+1 -1
View File
@@ -336,7 +336,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Protocols/CommandRunning.html
+2 -16
View File
@@ -248,13 +248,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a bash shell command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -427,13 +420,6 @@
<div class="pointer"></div>
<div class="abstract">
<p>Runs a command.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
<p>If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<p>_ = runAsync(<q>command</q>).stdout.read()</p>
</div>
</div>
<div class="declaration">
@@ -513,7 +499,7 @@
<p>Run executable and return before it is finished.</p>
<div class="aside aside-warning">
<p class="aside-title">Warning</p>
will crash if ‘executable’ could not be launched.
Will crash if ‘executable’ could not be launched.
</div>
@@ -641,7 +627,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Protocols/Context.html
+1 -1
View File
@@ -369,7 +369,7 @@ separate process and changing the directory there will not affect the rest of th
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Protocols/ReadableStream.html
+1 -1
View File
@@ -591,7 +591,7 @@ the handler, it may be called once when stream is closed and empty.
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Protocols/WritableStream.html
+1 -1
View File
@@ -431,7 +431,7 @@ Works exactly the same way as <code>print</code> from Swift&rsquo;s standard lib
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Structs.html
+1 -1
View File
@@ -282,7 +282,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Structs/CustomContext.html
+1 -1
View File
@@ -390,7 +390,7 @@ currentdirectory is the current working directory.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Structs/LazySplitSequence.html
+1 -1
View File
@@ -378,7 +378,7 @@ a separator, should empty slices be emitted? Defaults to false.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/Structs/PartialSourceLazySplitSequence.html
+1 -1
View File
@@ -285,7 +285,7 @@ or nil if there are no more collections.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/index.html
+1 -7
View File
@@ -441,12 +441,6 @@ The path to the application.</li>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">date</span> <span class="o">=</span> <span class="nf">run</span><span class="p">(</span><span class="s">"date"</span><span class="p">,</span> <span class="s">"-u"</span><span class="p">)</span><span class="o">.</span><span class="n">stdout</span>
<span class="nf">print</span><span class="p">(</span><span class="s">"Today's date in UTC is "</span> <span class="o">+</span> <span class="n">date</span><span class="p">)</span>
</code></pre>
<p>&nbsp;</p>
<p>Note: If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<pre class="highlight swift"><code><span class="n">_</span> <span class="o">=</span> <span class="nf">runAsync</span><span class="p">(</span><span class="s">"command"</span><span class="p">)</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="nf">read</span><span class="p">()</span>
</code></pre>
<h4 id='print-output' class='heading'>Print output</h4>
<pre class="highlight swift"><code><span class="k">try</span> <span class="nf">runAndPrint</span><span class="p">(</span><span class="s">"executable"</span><span class="p">,</span> <span class="s">"arg"</span><span class="p">)</span>
</code></pre>
@@ -609,7 +603,7 @@ The path to the application.</li>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
docsets/SwiftShell.docset/Contents/Resources/Documents/search.json
+1 -1
View File
File diff suppressed because one or more lines are too long
docsets/SwiftShell.tgz
BIN
View File
Binary file not shown.
index.html
+1 -7
View File
@@ -441,12 +441,6 @@ The path to the application.</li>
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">date</span> <span class="o">=</span> <span class="nf">run</span><span class="p">(</span><span class="s">"date"</span><span class="p">,</span> <span class="s">"-u"</span><span class="p">)</span><span class="o">.</span><span class="n">stdout</span>
<span class="nf">print</span><span class="p">(</span><span class="s">"Today's date in UTC is "</span> <span class="o">+</span> <span class="n">date</span><span class="p">)</span>
</code></pre>
<p>&nbsp;</p>
<p>Note: If the output from the command into either standard output or standard error is larger than 65,536 bytes, the command will hang and never finish (<a href="https://github.com/kareman/SwiftShell/issues/52">#52</a>). To work around this problem, use runAsync instead and read all the output, even if you&rsquo;re not going to use it:</p>
<pre class="highlight swift"><code><span class="n">_</span> <span class="o">=</span> <span class="nf">runAsync</span><span class="p">(</span><span class="s">"command"</span><span class="p">)</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="nf">read</span><span class="p">()</span>
</code></pre>
<h4 id='print-output' class='heading'>Print output</h4>
<pre class="highlight swift"><code><span class="k">try</span> <span class="nf">runAndPrint</span><span class="p">(</span><span class="s">"executable"</span><span class="p">,</span> <span class="s">"arg"</span><span class="p">)</span>
</code></pre>
@@ -609,7 +603,7 @@ The path to the application.</li>
</section>
</section>
<section id="footer">
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-02-13)</p>
<p>&copy; 2018 <a class="link" href="" target="_blank" rel="external">kareman</a>. All rights reserved. (Last updated: 2018-03-04)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.1</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
search.json
+1 -1
View File
File diff suppressed because one or more lines are too long
undocumented.json
+5 -5
View File
@@ -2,35 +2,35 @@
"warnings": [
{
"file": "/Users/karemorstol/Programming/SwiftShell/SwiftShell3/Sources/SwiftShell/Command.swift",
"line": 52,
"line": 53,
"symbol": "CommandRunning.context",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/Users/karemorstol/Programming/SwiftShell/SwiftShell3/Sources/SwiftShell/Command.swift",
"line": 56,
"line": 57,
"symbol": "CommandRunning.context",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/Users/karemorstol/Programming/SwiftShell/SwiftShell3/Sources/SwiftShell/Command.swift",
"line": 123,
"line": 124,
"symbol": "==(_:_:)",
"symbol_kind": "source.lang.swift.decl.function.free",
"warning": "undocumented"
},
{
"file": "/Users/karemorstol/Programming/SwiftShell/SwiftShell3/Sources/SwiftShell/Command.swift",
"line": 259,
"line": 279,
"symbol": "AsyncCommand.stdout",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"
},
{
"file": "/Users/karemorstol/Programming/SwiftShell/SwiftShell3/Sources/SwiftShell/Command.swift",
"line": 260,
"line": 280,
"symbol": "AsyncCommand.stderror",
"symbol_kind": "source.lang.swift.decl.var.instance",
"warning": "undocumented"