summaryrefslogtreecommitdiff
path: root/.config/micro/plug/wc/help
diff options
context:
space:
mode:
Diffstat (limited to '.config/micro/plug/wc/help')
-rw-r--r--.config/micro/plug/wc/help/wc.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/.config/micro/plug/wc/help/wc.md b/.config/micro/plug/wc/help/wc.md
new file mode 100644
index 0000000..ad36643
--- /dev/null
+++ b/.config/micro/plug/wc/help/wc.md
@@ -0,0 +1,25 @@
+# WordCount (wc) Plugin #
+
+The wc plugin provides the user with the ability to count either
+characters or strings in any text being edited with micro.
+
+A word is defined as a string of characters delimited by white
+space characters. White space characters are the set of characters
+for which the iswspace(3) function returns true.
+
+A line is defined as a string of characters delimited by \n
+characters, or by the beginning or end of the file. \r\n line
+endings will be counted correctly as well, since there is only
+one \n per \r\n.
+
+Character count includes white space and newline characters.
+
+To initiate the function, you can either:
+
+Press "F5"
+
+Or run:
+
+```
+> wc
+```