autogenerated mdbook documentation

Cargo.toml

@@ -9,6 +9,7 @@ version = "0.0.9"
 authors = ["uutils developers"]
 license = "MIT"
 description = "coreutils ~ GNU coreutils (updated); implemented as universal (cross-platform) utils, written in Rust"
+default-run = "coreutils"
 
 homepage = "https://github.com/uutils/coreutils"
 repository = "https://github.com/uutils/coreutils"

docs/.gitignore

@@ -0,0 +1,2 @@
+book
+_generated

docs/CONTRIBUTING.md

@@ -0,0 +1 @@
+# Contributing

docs/arch.rst

@@ -1,28 +0,0 @@
-.. print machine hardware name
-
-====
-arch
-====
-
-.. FIXME: this needs to be autogenerated somehow
-
---------
-Synopsis
---------
-
-``arch`` [OPTION]...
-
------------
-Description
------------
-
-``arch`` is an alias for ``uname -m``.  They both print the machine hardware
-name.
-
-An exit code of zero indicates success, whereas anything else means failure.
-For this program, a non-zero exit code generally means the user provided
-invalid options.
-
--h, --help       print a help menu for this program displaying accepted
-                 options and arguments
--v, --version    print the version number of this program

docs/book.toml

@@ -0,0 +1,9 @@
+[book]
+authors = ["uutils contributors"]
+language = "en"
+multilingual = false
+src = "src"
+title = "Uutils Documentation"
+
+[output.html]
+git-repository-url = "https://github.com/rust-lang/cargo/tree/master/src/doc/src"

docs/create_docs.py

@@ -0,0 +1,20 @@
+# Simple script to create the correct SUMMARY.md and other files
+# for the mdbook documentation.
+# Note: This will overwrite the existing files!
+
+import os
+
+with open('src/utils/index.md', 'w') as index:
+    with open('src/SUMMARY.md', 'w') as summary:
+        summary.write("# Summary\n\n")
+        summary.write("* [Introduction](introduction.md)\n")
+        summary.write("* [Contributing](contributing.md)\n")
+        summary.write("* [Utils](utils/index.md)\n")
+        index.write("# Utils\n\n")
+        for d in sorted(os.listdir('../src/uu')):
+            with open(f"src/utils/{d}.md", 'w') as f:
+                f.write(f"# {d}\n\n")
+                f.write(f"{{{{ #include ../../_generated/{d}-help.md }}}}\n")
+                print(f"Created docs/src/utils/{d}.md")
+            summary.write(f"  * [{d}](utils/{d}.md)\n")
+            index.write(f"* [{d}](./{d}.md)\n")

docs/docs/.gitignore

@@ -1 +0,0 @@
-book

docs/docs/book.toml

@@ -1,6 +0,0 @@
-[book]
-authors = ["Terts Diepraam"]
-language = "en"
-multilingual = false
-src = "src"
-title = "Uutils Documentation"

docs/docs/src/SUMMARY.md

@@ -1,3 +0,0 @@
-# Summary
-
-- [Chapter 1](./chapter_1.md)

docs/docs/src/chapter_1.md

@@ -1 +0,0 @@
-# Chapter 1

docs/index.rst

@@ -1,24 +0,0 @@
-.. uutils documentation master file, created by
-   sphinx-quickstart on Tue Dec  5 23:20:18 2017.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-..
-   spell-checker:ignore (directives) genindex maxdepth modindex toctree ; (misc) quickstart
-
-Welcome to uutils' documentation!
-=================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-   arch
-   uutils
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/src/SUMMARY.md

@@ -0,0 +1,105 @@
+# Summary
+
+* [Introduction](introduction.md)
+* [Contributing](contributing.md)
+* [Utils](utils/index.md)
+  * [arch](utils/arch.md)
+  * [base32](utils/base32.md)
+  * [base64](utils/base64.md)
+  * [basename](utils/basename.md)
+  * [basenc](utils/basenc.md)
+  * [cat](utils/cat.md)
+  * [chcon](utils/chcon.md)
+  * [chgrp](utils/chgrp.md)
+  * [chmod](utils/chmod.md)
+  * [chown](utils/chown.md)
+  * [chroot](utils/chroot.md)
+  * [cksum](utils/cksum.md)
+  * [comm](utils/comm.md)
+  * [cp](utils/cp.md)
+  * [csplit](utils/csplit.md)
+  * [cut](utils/cut.md)
+  * [date](utils/date.md)
+  * [dd](utils/dd.md)
+  * [df](utils/df.md)
+  * [dircolors](utils/dircolors.md)
+  * [dirname](utils/dirname.md)
+  * [du](utils/du.md)
+  * [echo](utils/echo.md)
+  * [env](utils/env.md)
+  * [expand](utils/expand.md)
+  * [expr](utils/expr.md)
+  * [factor](utils/factor.md)
+  * [false](utils/false.md)
+  * [fmt](utils/fmt.md)
+  * [fold](utils/fold.md)
+  * [groups](utils/groups.md)
+  * [hashsum](utils/hashsum.md)
+  * [head](utils/head.md)
+  * [hostid](utils/hostid.md)
+  * [hostname](utils/hostname.md)
+  * [id](utils/id.md)
+  * [install](utils/install.md)
+  * [join](utils/join.md)
+  * [kill](utils/kill.md)
+  * [link](utils/link.md)
+  * [ln](utils/ln.md)
+  * [logname](utils/logname.md)
+  * [ls](utils/ls.md)
+  * [mkdir](utils/mkdir.md)
+  * [mkfifo](utils/mkfifo.md)
+  * [mknod](utils/mknod.md)
+  * [mktemp](utils/mktemp.md)
+  * [more](utils/more.md)
+  * [mv](utils/mv.md)
+  * [nice](utils/nice.md)
+  * [nl](utils/nl.md)
+  * [nohup](utils/nohup.md)
+  * [nproc](utils/nproc.md)
+  * [numfmt](utils/numfmt.md)
+  * [od](utils/od.md)
+  * [paste](utils/paste.md)
+  * [pathchk](utils/pathchk.md)
+  * [pinky](utils/pinky.md)
+  * [pr](utils/pr.md)
+  * [printenv](utils/printenv.md)
+  * [printf](utils/printf.md)
+  * [ptx](utils/ptx.md)
+  * [pwd](utils/pwd.md)
+  * [readlink](utils/readlink.md)
+  * [realpath](utils/realpath.md)
+  * [relpath](utils/relpath.md)
+  * [rm](utils/rm.md)
+  * [rmdir](utils/rmdir.md)
+  * [runcon](utils/runcon.md)
+  * [seq](utils/seq.md)
+  * [shred](utils/shred.md)
+  * [shuf](utils/shuf.md)
+  * [sleep](utils/sleep.md)
+  * [sort](utils/sort.md)
+  * [split](utils/split.md)
+  * [stat](utils/stat.md)
+  * [stdbuf](utils/stdbuf.md)
+  * [sum](utils/sum.md)
+  * [sync](utils/sync.md)
+  * [tac](utils/tac.md)
+  * [tail](utils/tail.md)
+  * [tee](utils/tee.md)
+  * [test](utils/test.md)
+  * [timeout](utils/timeout.md)
+  * [touch](utils/touch.md)
+  * [tr](utils/tr.md)
+  * [true](utils/true.md)
+  * [truncate](utils/truncate.md)
+  * [tsort](utils/tsort.md)
+  * [tty](utils/tty.md)
+  * [uname](utils/uname.md)
+  * [unexpand](utils/unexpand.md)
+  * [uniq](utils/uniq.md)
+  * [unlink](utils/unlink.md)
+  * [uptime](utils/uptime.md)
+  * [users](utils/users.md)
+  * [wc](utils/wc.md)
+  * [who](utils/who.md)
+  * [whoami](utils/whoami.md)
+  * [yes](utils/yes.md)

docs/src/contributing.md

@@ -0,0 +1 @@
+{{ #include ../../CONTRIBUTING.md }}

docs/src/introduction.md

@@ -0,0 +1,8 @@
+# Introduction
+
+uutils is an attempt at writing universal (as in cross-platform) CLI
+utilities in [Rust](https://www.rust-lang.org). The source code is hosted
+on [GitHub](https://github.com/uutils/coreutils).
+
+> Note: This manual is automatically generated from the source code and is
+> a work in progress.

docs/src/utils/arch.md

@@ -0,0 +1,3 @@
+# arch
+
+{{ #include ../../_generated/arch-help.md }}

docs/src/utils/base32.md

@@ -0,0 +1,3 @@
+# base32
+
+{{ #include ../../_generated/base32-help.md }}

docs/src/utils/base64.md

@@ -0,0 +1,3 @@
+# base64
+
+{{ #include ../../_generated/base64-help.md }}

docs/src/utils/basename.md

@@ -0,0 +1,3 @@
+# basename
+
+{{ #include ../../_generated/basename-help.md }}

docs/src/utils/basenc.md

@@ -0,0 +1,3 @@
+# basenc
+
+{{ #include ../../_generated/basenc-help.md }}

docs/src/utils/cat.md

@@ -0,0 +1,3 @@
+# cat
+
+{{ #include ../../_generated/cat-help.md }}

docs/src/utils/chcon.md

@@ -0,0 +1,3 @@
+# chcon
+
+{{ #include ../../_generated/chcon-help.md }}

docs/src/utils/chgrp.md

@@ -0,0 +1,3 @@
+# chgrp
+
+{{ #include ../../_generated/chgrp-help.md }}

docs/src/utils/chmod.md

@@ -0,0 +1,3 @@
+# chmod
+
+{{ #include ../../_generated/chmod-help.md }}

docs/src/utils/chown.md

@@ -0,0 +1,3 @@
+# chown
+
+{{ #include ../../_generated/chown-help.md }}

docs/src/utils/chroot.md

@@ -0,0 +1,3 @@
+# chroot
+
+{{ #include ../../_generated/chroot-help.md }}

docs/src/utils/cksum.md

@@ -0,0 +1,3 @@
+# cksum
+
+{{ #include ../../_generated/cksum-help.md }}

docs/src/utils/comm.md

@@ -0,0 +1,3 @@
+# comm
+
+{{ #include ../../_generated/comm-help.md }}

docs/src/utils/cp.md

@@ -0,0 +1,3 @@
+# cp
+
+{{ #include ../../_generated/cp-help.md }}

docs/src/utils/csplit.md

@@ -0,0 +1,3 @@
+# csplit
+
+{{ #include ../../_generated/csplit-help.md }}

docs/src/utils/cut.md

@@ -0,0 +1,3 @@
+# cut
+
+{{ #include ../../_generated/cut-help.md }}

docs/src/utils/date.md

@@ -0,0 +1,3 @@
+# date
+
+{{ #include ../../_generated/date-help.md }}

docs/src/utils/dd.md

@@ -0,0 +1,3 @@
+# dd
+
+{{ #include ../../_generated/dd-help.md }}

docs/src/utils/df.md

@@ -0,0 +1,3 @@
+# df
+
+{{ #include ../../_generated/df-help.md }}

docs/src/utils/dircolors.md

@@ -0,0 +1,3 @@
+# dircolors
+
+{{ #include ../../_generated/dircolors-help.md }}

docs/src/utils/dirname.md

@@ -0,0 +1,3 @@
+# dirname
+
+{{ #include ../../_generated/dirname-help.md }}

docs/src/utils/du.md

@@ -0,0 +1,3 @@
+# du
+
+{{ #include ../../_generated/du-help.md }}

docs/src/utils/echo.md

@@ -0,0 +1,3 @@
+# echo
+
+{{ #include ../../_generated/echo-help.md }}

docs/src/utils/env.md

@@ -0,0 +1,3 @@
+# env
+
+{{ #include ../../_generated/env-help.md }}

docs/src/utils/expand.md

@@ -0,0 +1,3 @@
+# expand
+
+{{ #include ../../_generated/expand-help.md }}

docs/src/utils/expr.md

@@ -0,0 +1,3 @@
+# expr
+
+{{ #include ../../_generated/expr-help.md }}

docs/src/utils/factor.md

@@ -0,0 +1,3 @@
+# factor
+
+{{ #include ../../_generated/factor-help.md }}

docs/src/utils/false.md

@@ -0,0 +1,3 @@
+# false
+
+{{ #include ../../_generated/false-help.md }}

docs/src/utils/fmt.md

@@ -0,0 +1,3 @@
+# fmt
+
+{{ #include ../../_generated/fmt-help.md }}

docs/src/utils/fold.md

@@ -0,0 +1,3 @@
+# fold
+
+{{ #include ../../_generated/fold-help.md }}

docs/src/utils/groups.md

@@ -0,0 +1,3 @@
+# groups
+
+{{ #include ../../_generated/groups-help.md }}

docs/src/utils/hashsum.md

@@ -0,0 +1,3 @@
+# hashsum
+
+{{ #include ../../_generated/hashsum-help.md }}

docs/src/utils/head.md

@@ -0,0 +1,3 @@
+# head
+
+{{ #include ../../_generated/head-help.md }}

docs/src/utils/hostid.md

@@ -0,0 +1,3 @@
+# hostid
+
+{{ #include ../../_generated/hostid-help.md }}

docs/src/utils/hostname.md

@@ -0,0 +1,3 @@
+# hostname
+
+{{ #include ../../_generated/hostname-help.md }}

docs/src/utils/id.md

@@ -0,0 +1,3 @@
+# id
+
+{{ #include ../../_generated/id-help.md }}

docs/src/utils/index.md

@@ -0,0 +1,102 @@
+# Utils
+
+* [arch](./arch.md)
+* [base32](./base32.md)
+* [base64](./base64.md)
+* [basename](./basename.md)
+* [basenc](./basenc.md)
+* [cat](./cat.md)
+* [chcon](./chcon.md)
+* [chgrp](./chgrp.md)
+* [chmod](./chmod.md)
+* [chown](./chown.md)
+* [chroot](./chroot.md)
+* [cksum](./cksum.md)
+* [comm](./comm.md)
+* [cp](./cp.md)
+* [csplit](./csplit.md)
+* [cut](./cut.md)
+* [date](./date.md)
+* [dd](./dd.md)
+* [df](./df.md)
+* [dircolors](./dircolors.md)
+* [dirname](./dirname.md)
+* [du](./du.md)
+* [echo](./echo.md)
+* [env](./env.md)
+* [expand](./expand.md)
+* [expr](./expr.md)
+* [factor](./factor.md)
+* [false](./false.md)
+* [fmt](./fmt.md)
+* [fold](./fold.md)
+* [groups](./groups.md)
+* [hashsum](./hashsum.md)
+* [head](./head.md)
+* [hostid](./hostid.md)
+* [hostname](./hostname.md)
+* [id](./id.md)
+* [install](./install.md)
+* [join](./join.md)
+* [kill](./kill.md)
+* [link](./link.md)
+* [ln](./ln.md)
+* [logname](./logname.md)
+* [ls](./ls.md)
+* [mkdir](./mkdir.md)
+* [mkfifo](./mkfifo.md)
+* [mknod](./mknod.md)
+* [mktemp](./mktemp.md)
+* [more](./more.md)
+* [mv](./mv.md)
+* [nice](./nice.md)
+* [nl](./nl.md)
+* [nohup](./nohup.md)
+* [nproc](./nproc.md)
+* [numfmt](./numfmt.md)
+* [od](./od.md)
+* [paste](./paste.md)
+* [pathchk](./pathchk.md)
+* [pinky](./pinky.md)
+* [pr](./pr.md)
+* [printenv](./printenv.md)
+* [printf](./printf.md)
+* [ptx](./ptx.md)
+* [pwd](./pwd.md)
+* [readlink](./readlink.md)
+* [realpath](./realpath.md)
+* [relpath](./relpath.md)
+* [rm](./rm.md)
+* [rmdir](./rmdir.md)
+* [runcon](./runcon.md)
+* [seq](./seq.md)
+* [shred](./shred.md)
+* [shuf](./shuf.md)
+* [sleep](./sleep.md)
+* [sort](./sort.md)
+* [split](./split.md)
+* [stat](./stat.md)
+* [stdbuf](./stdbuf.md)
+* [sum](./sum.md)
+* [sync](./sync.md)
+* [tac](./tac.md)
+* [tail](./tail.md)
+* [tee](./tee.md)
+* [test](./test.md)
+* [timeout](./timeout.md)
+* [touch](./touch.md)
+* [tr](./tr.md)
+* [true](./true.md)
+* [truncate](./truncate.md)
+* [tsort](./tsort.md)
+* [tty](./tty.md)
+* [uname](./uname.md)
+* [unexpand](./unexpand.md)
+* [uniq](./uniq.md)
+* [unlink](./unlink.md)
+* [uptime](./uptime.md)
+* [users](./users.md)
+* [wc](./wc.md)
+* [who](./who.md)
+* [whoami](./whoami.md)
+* [yes](./yes.md)

docs/src/utils/install.md

@@ -0,0 +1,3 @@
+# install
+
+{{ #include ../../_generated/install-help.md }}

docs/src/utils/join.md

@@ -0,0 +1,3 @@
+# join
+
+{{ #include ../../_generated/join-help.md }}

docs/src/utils/kill.md

@@ -0,0 +1,3 @@
+# kill
+
+{{ #include ../../_generated/kill-help.md }}

docs/src/utils/link.md

@@ -0,0 +1,3 @@
+# link
+
+{{ #include ../../_generated/link-help.md }}

docs/src/utils/ln.md

@@ -0,0 +1,3 @@
+# ln
+
+{{ #include ../../_generated/ln-help.md }}

docs/src/utils/logname.md

@@ -0,0 +1,3 @@
+# logname
+
+{{ #include ../../_generated/logname-help.md }}

docs/src/utils/ls.md

@@ -0,0 +1,3 @@
+# ls
+
+{{ #include ../../_generated/ls-help.md }}

docs/src/utils/mkdir.md

@@ -0,0 +1,3 @@
+# mkdir
+
+{{ #include ../../_generated/mkdir-help.md }}

docs/src/utils/mkfifo.md

@@ -0,0 +1,3 @@
+# mkfifo
+
+{{ #include ../../_generated/mkfifo-help.md }}

docs/src/utils/mknod.md

@@ -0,0 +1,3 @@
+# mknod
+
+{{ #include ../../_generated/mknod-help.md }}

docs/src/utils/mktemp.md

@@ -0,0 +1,3 @@
+# mktemp
+
+{{ #include ../../_generated/mktemp-help.md }}

docs/src/utils/more.md

@@ -0,0 +1,3 @@
+# more
+
+{{ #include ../../_generated/more-help.md }}

docs/src/utils/mv.md

@@ -0,0 +1,3 @@
+# mv
+
+{{ #include ../../_generated/mv-help.md }}

docs/src/utils/nice.md

@@ -0,0 +1,3 @@
+# nice
+
+{{ #include ../../_generated/nice-help.md }}

docs/src/utils/nl.md

@@ -0,0 +1,3 @@
+# nl
+
+{{ #include ../../_generated/nl-help.md }}

docs/src/utils/nohup.md

@@ -0,0 +1,3 @@
+# nohup
+
+{{ #include ../../_generated/nohup-help.md }}

docs/src/utils/nproc.md

@@ -0,0 +1,3 @@
+# nproc
+
+{{ #include ../../_generated/nproc-help.md }}

docs/src/utils/numfmt.md

@@ -0,0 +1,3 @@
+# numfmt
+
+{{ #include ../../_generated/numfmt-help.md }}

docs/src/utils/od.md

@@ -0,0 +1,3 @@
+# od
+
+{{ #include ../../_generated/od-help.md }}

docs/src/utils/paste.md

@@ -0,0 +1,3 @@
+# paste
+
+{{ #include ../../_generated/paste-help.md }}

docs/src/utils/pathchk.md

@@ -0,0 +1,3 @@
+# pathchk
+
+{{ #include ../../_generated/pathchk-help.md }}

docs/src/utils/pinky.md

@@ -0,0 +1,3 @@
+# pinky
+
+{{ #include ../../_generated/pinky-help.md }}

docs/src/utils/pr.md

@@ -0,0 +1,3 @@
+# pr
+
+{{ #include ../../_generated/pr-help.md }}

docs/src/utils/printenv.md

@@ -0,0 +1,3 @@
+# printenv
+
+{{ #include ../../_generated/printenv-help.md }}

docs/src/utils/printf.md

@@ -0,0 +1,3 @@
+# printf
+
+{{ #include ../../_generated/printf-help.md }}

docs/src/utils/ptx.md

@@ -0,0 +1,3 @@
+# ptx
+
+{{ #include ../../_generated/ptx-help.md }}

docs/src/utils/pwd.md

@@ -0,0 +1,3 @@
+# pwd
+
+{{ #include ../../_generated/pwd-help.md }}

docs/src/utils/readlink.md

@@ -0,0 +1,3 @@
+# readlink
+
+{{ #include ../../_generated/readlink-help.md }}

docs/src/utils/realpath.md

@@ -0,0 +1,3 @@
+# realpath
+
+{{ #include ../../_generated/realpath-help.md }}

docs/src/utils/relpath.md

@@ -0,0 +1,3 @@
+# relpath
+
+{{ #include ../../_generated/relpath-help.md }}

docs/src/utils/rm.md

@@ -0,0 +1,3 @@
+# rm
+
+{{ #include ../../_generated/rm-help.md }}

docs/src/utils/rmdir.md

@@ -0,0 +1,3 @@
+# rmdir
+
+{{ #include ../../_generated/rmdir-help.md }}

docs/src/utils/runcon.md

@@ -0,0 +1,3 @@
+# runcon
+
+{{ #include ../../_generated/runcon-help.md }}

docs/src/utils/seq.md

@@ -0,0 +1,3 @@
+# seq
+
+{{ #include ../../_generated/seq-help.md }}

docs/src/utils/shred.md

@@ -0,0 +1,3 @@
+# shred
+
+{{ #include ../../_generated/shred-help.md }}

docs/src/utils/shuf.md

@@ -0,0 +1,3 @@
+# shuf
+
+{{ #include ../../_generated/shuf-help.md }}

docs/src/utils/sleep.md

@@ -0,0 +1,3 @@
+# sleep
+
+{{ #include ../../_generated/sleep-help.md }}

docs/src/utils/sort.md

@@ -0,0 +1,3 @@
+# sort
+
+{{ #include ../../_generated/sort-help.md }}

docs/src/utils/split.md

@@ -0,0 +1,3 @@
+# split
+
+{{ #include ../../_generated/split-help.md }}

docs/src/utils/stat.md

@@ -0,0 +1,3 @@
+# stat
+
+{{ #include ../../_generated/stat-help.md }}

docs/src/utils/stdbuf.md

@@ -0,0 +1,3 @@
+# stdbuf
+
+{{ #include ../../_generated/stdbuf-help.md }}

docs/src/utils/sum.md

@@ -0,0 +1,3 @@
+# sum
+
+{{ #include ../../_generated/sum-help.md }}

docs/src/utils/sync.md

@@ -0,0 +1,3 @@
+# sync
+
+{{ #include ../../_generated/sync-help.md }}

docs/src/utils/tac.md

@@ -0,0 +1,3 @@
+# tac
+
+{{ #include ../../_generated/tac-help.md }}

docs/src/utils/tail.md

@@ -0,0 +1,3 @@
+# tail
+
+{{ #include ../../_generated/tail-help.md }}

docs/src/utils/tee.md

@@ -0,0 +1,3 @@
+# tee
+
+{{ #include ../../_generated/tee-help.md }}

docs/src/utils/test.md

@@ -0,0 +1,3 @@
+# test
+
+{{ #include ../../_generated/test-help.md }}

docs/src/utils/timeout.md

@@ -0,0 +1,3 @@
+# timeout
+
+{{ #include ../../_generated/timeout-help.md }}