docs/index.html in update_repo-0.11.1 vs docs/index.html in update_repo-0.11.2
- old
+ new
@@ -101,11 +101,11 @@
</code>
</pre></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Color</p></div><div class="cmd-body row-body"><p class="cmd-text">Determines if the output will be displayed in color or not. Default is TRUE. Note that regardless of this setting, when one of the '--dump-*' options is specified output will not be in color. No color codes will be saved to the logfile either.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">color:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--color</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-c</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-color</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">true</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Dump</p></div><div class="cmd-body row-body"><p class="cmd-text">Dumps a CSV file of each directory and its associated git remote URL to the console, and to the logfile if that is enabled.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--dump</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-d</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Prune</p></div><div class="cmd-body row-body"><p class="cmd-text">Used in conjunction with the --dump option to remove the first <integer> directory levels from the output. This will enable it to be imported back into a different directory structure.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">prune:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--prune</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-p</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">0</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Log</p></div><div class="cmd-body row-body"><p class="cmd-text">Copies all script output to a logfile as well as STDOUT. The default logfile name is 'updaterepo.log' in the current users home directory. The previous log will be overwritten, but see the next option.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">log:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--log</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-l</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-log</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Timestamp</p></div><div class="cmd-body row-body"><p class="cmd-text">Used in conjunction with the --log option to rename the logfile with an added timestamp, thus not overwriting older logs</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">timestamp:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--timestamp</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-t</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-timestamp</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Log Local</p></div><div class="cmd-body row-body"><p class="cmd-text">Store the logfile (if this is enabled) in the current working directory instead of the Users' Home directory</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">log_local:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--log-local</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-g</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-log-local</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Verbose</p></div><div class="cmd-body row-body"><p class="cmd-text">Display all raw Git output plus repository URL and location instead of the reduced output in the default mode. Note that the short-form command is the UPERCASE 'V' not lower!</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">verbose:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--verbose</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-V</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-verbose</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Verbose Errors</p></div><div class="cmd-body row-body"><p class="cmd-text">List all the error output from a failing command in the summary, not just the first line</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">verbose_errors:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--verbose-errors</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-E</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-verbose-errors</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Brief Output</p></div><div class="cmd-body row-body"><p class="cmd-text">Do not print the Header, Footer or Summary.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">brief:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--brief</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-b</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-brief</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Quiet</p></div><div class="cmd-body row-body"><p class="cmd-text">No output will be displayed to screen during the running of script, except for any fatal errors.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">quiet:</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--quiet</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-q</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">--no-quiet</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Dump Remotes</p></div><div class="cmd-body row-body"><p class="cmd-text">Dumps a bare list to the console of all the Git remote URL's found in the specified directories. This can be saved by redirecting to file or using the --log option.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--dump-remotes</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-r</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Save Errors</p></div><div class="cmd-body row-body"><p class="cmd-text">Save any Git error messages from the last run for future display. These can be displayed using the Show Errors command below, which will display previous errors then exit without running another pass.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">save_errors</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--save-errors</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-s</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Show Errors</p></div><div class="cmd-body row-body"><p class="cmd-text">Prints any errors detected in the previous run then exits. This needs the 'Save Errors' option above to be enabled.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--show-errors</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-S</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>No Internet connection check</p></div><div class="cmd-body row-body"><p class="cmd-text">Does not check for a working Internet connection before running the Script.</p><p class="cmd-text">Equivalent to the <span class="yaml-tag">noinetchk</span> YAML configuration file tag.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--noinetchk</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-n</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Version</p></div><div class="cmd-body row-body"><p class="cmd-text">Displays the current version number then terminates. All other options will be ignored.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--version</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-v</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div><div class="col-lg-12 col-md-12"><div class="cmd-header row-header"><p>Help</p></div><div class="cmd-body row-body"><p class="cmd-text">Displays a brief help text listing syntax and availiable switches then terminates. All other options will be ignored.</p><p class="cmd-text">No equivalent in the YAML Configuration file.</p><ul class="opt-list"><li class="cmd-opt"><span class="desc">Long-Form</span> : <span class="cmdline">--help</span></li><li class="cmd-opt"><span class="desc">Short-Form</span> : <span class="cmdline">-h</span></li><li class="cmd-opt"><span class="desc">Negative-Form</span> : <span class="cmdline">None.</span></li><li class="cmd-opt"><span class="desc">Default</span> : <span class="cmdline">false</span></li></ul></div></div></div></div></section><section class="contribute" id="contribute"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-code-branch"></span> Contribute to the Development</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><h2>Contributing</h2><p>The source code for <span class="console-output">update_repo</span> is freely available on my <a target="_blank" class="icon fa-external-link" href="https://github.com/seapagan/update_repo">Github</a> pages, under the <a class="icon fa-external-link" target="_blank" href="http://opensource.org/licenses/MIT">MIT</a> license.</p><p>If you wish to help in any way then :</p><ol><li>Fork it</li><li>Create your feature branch (<span class="console-output">git checkout -b my-new-feature</span>)</li><li>Commit your changes (<span class="console-output">git commit -am 'Add some feature'</span>)</li><li>Push to the branch (<span class="console-output">git push origin my-new-feature</span>)</li><li>Create a new Pull Request</li></ol><p>For full information on how to contribute to the development of this Gem or the Website, please see the Development section on the projects <a class="icon fa-external-link" target="_blank" href="https://github.com/seapagan/update_repo#development">Github repository</a>.</p></div></div></div></section><section class="license" id="license"><div class="container"><div class="row row-header"><div class="col-lg-12 col-md-12"><h1><span class="fas fa-book"></span> License</h1></div></div><div class="row row-body"><div class="col-lg-12 col-md-12"><p>The gem is available as open source under the terms of the <a class="icon fa-external-link" target="_blank" href="http://opensource.org/licenses/MIT">MIT</a> License, see the file <span class="filename">LICENSE.txt</span>, also reproduced below :</p><pre>
<code class="language-markup">
The MIT License (MIT)
- Copyright (c) 2019 Grant Ramsay
+ Copyright (c) 2020 Grant Ramsay
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
@@ -121,6 +121,6 @@
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
</code>
- </pre></div></div></div></section><footer class="footer"><div class="container"><div class="row"><div class="col-lg-12 text-right">© Grant Ramsay 2019 | <span class="site-version">Website v2.0-beta</span> | See my public projects on <a target="_blank" class="icon fa-github" href="https://github.com/seapagan">Github</a></div></div></div></footer><script src="js/main-min.js"></script></body></html>
\ No newline at end of file
+ </pre></div></div></div></section><footer class="footer"><div class="container"><div class="row"><div class="col-lg-12 text-right">© Grant Ramsay 2020 | <span class="site-version">Website v2.0-beta</span> | See my public projects on <a target="_blank" class="icon fa-github" href="https://github.com/seapagan">Github</a></div></div></div></footer><script src="js/main-min.js"></script></body></html>