Rename binary: shellfu-doc to sfdoc

'sfdoc' is easier to type and resembles 'pydoc' and 'perldoc' so it's
even easier to remember.

README.md

@@ -85,18 +85,18 @@ That should return path to *shellfu.sh* and version, respectively.
 And that's also *all* this command does.
 
 Next, if you have also installed some modules, you can look around
-using `shellfu-doc`:
+using `sfdoc`:
 
-    shellfu-doc --lsmods
-    shellfu-doc inigrep
+    sfdoc --lsmods
+    sfdoc inigrep
 
 This is how you access documentation of modules available on the system.
 You can also access documentation of a modules directly by specifying
 path to the file (the path must contain slash):
 
-    shellfu-doc path/to/my/module.sh
+    sfdoc path/to/my/module.sh
 
-Note that shellfu-doc only works if the module follows Shellfu Style
+Note that sfdoc only works if the module follows Shellfu Style
 Guide, in particular the Docstrings section.
 
 Next, you can create your first Shellfu-Bash script:
@@ -130,7 +130,7 @@ This is how above script works:
  2. Using `shellfu import pretty`, we're importing module called "pretty".
     shellfu will figure out where exactly it is.
 
- 3. If we called `shellfu-doc pretty` in another terminal, we would find
+ 3. If we called `sfdoc pretty` in another terminal, we would find
     out that among others, this module contains functions `think`, `debug`,
     `warn` and `die`.
 
@@ -162,7 +162,7 @@ to do is
     my_module.sh is.
 
 To get the basic stuff, nothing more is really needed.  If you want, however,
-your module be explorable by `shellfu-doc`, you need to follow Shellfu Style
+your module be explorable by `sfdoc`, you need to follow Shellfu Style
 Guide.
 
 

mkit.ini

@@ -41,7 +41,7 @@
     share    = 644
 
 [files]
-    bin      = src/bin/shellfu-doc
+    bin      = src/bin/sfdoc
     bin      = src/bin/shellfu-embed
     bin      = src/bin/sfpath
     doc      = LICENSE.md

notes/intro.md

@@ -75,7 +75,7 @@ Shellfu, as a project consists of three parts:
     allowing you to collaborate on the code in an efficient manner
     (in-line documentation, peer review, code readability...).
 
- *  As a bonus, *shellfu-doc*, building upon the Shellfu Style Guide,
+ *  As a bonus, *sfdoc*, building upon the Shellfu Style Guide,
     allows your user to discover and read documentation of installed
     modules (akin to *perldoc* or *pydoc*).
 

packaging/debian/shellfu-devel.install

@@ -1,3 +1,3 @@
 /etc/bash_completion.d/shellfu-devel.bash
-/usr/bin/shellfu-doc
+/usr/bin/sfdoc
 /usr/bin/shellfu-embed

packaging/template.spec

@@ -50,7 +50,7 @@ Summary: Essential developer tools
 Requires: shellfu-bash-core
 %description devel
 This sub-package contains tools useful mostly for development of shellfu
-scripts; most notably shellfu-doc which provides access to online
+scripts; most notably sfdoc which provides access to online
 (as in traditional man pages) documentation of shellfu modules.
 
 %package sh
@@ -111,7 +111,7 @@ make test \
 
 %files devel
 %config %{_sysconfdir}/bash_completion.d/shellfu-devel.bash
-%{_bindir}/shellfu-doc
+%{_bindir}/sfdoc
 %{_bindir}/shellfu-embed
 
 %files sh

tests/shellfu_doc/TF_RUN → tests/sfdoc/TF_RUN

@@ -29,12 +29,12 @@ tf_do_subtest() {
     local name=$1
     local cmd
     case $name in
-        lsx_tricky)    cmd="shellfu-doc --ls test/include/tricky.sh" ;;
-        lsv_tricky)    cmd="shellfu-doc --lsvar test/include/tricky.sh" ;;
-        lsf_tricky)    cmd="shellfu-doc --lsfun test/include/tricky.sh" ;;
-        direct_path)   cmd="shellfu-doc -e markdown test/other/path.sh" ;;
-        included_path) cmd="shellfu-doc -I test/other -e markdown path" ;;
-        *)             cmd="shellfu-doc -e markdown $name" ;;
+        lsx_tricky)    cmd="sfdoc --ls test/include/tricky.sh" ;;
+        lsv_tricky)    cmd="sfdoc --lsvar test/include/tricky.sh" ;;
+        lsf_tricky)    cmd="sfdoc --lsfun test/include/tricky.sh" ;;
+        direct_path)   cmd="sfdoc -e markdown test/other/path.sh" ;;
+        included_path) cmd="sfdoc -I test/other -e markdown path" ;;
+        *)             cmd="sfdoc -e markdown $name" ;;
     esac
     tf_testflt -n "$name" -O "oracle/$name.stdout" -E "oracle/$name.stderr" "$cmd"
 }

tests/shellfu_api/TF_RUN

@@ -25,12 +25,12 @@ flt_ours() {
 
 shellfu_get_all() {
     local t=$1      # type (functions, variables, modules)
-    shellfu-doc --all --lsmod \
+    sfdoc --all --lsmod \
       | flt_ours \
       | case $t in
             modules)    cat ;;
-            variables)  xargs -L1 shellfu-doc --all --lsvar ;;
-            functions)  xargs -L1 shellfu-doc --all --lsfun ;;
+            variables)  xargs -L1 sfdoc --all --lsvar ;;
+            functions)  xargs -L1 sfdoc --all --lsfun ;;
         esac \
       | LC_ALL=C sort
 }