summaryrefslogtreecommitdiffstats
path: root/tcllib/modules/textutil/repeat.man
diff options
context:
space:
mode:
Diffstat (limited to 'tcllib/modules/textutil/repeat.man')
-rw-r--r--tcllib/modules/textutil/repeat.man46
1 files changed, 46 insertions, 0 deletions
diff --git a/tcllib/modules/textutil/repeat.man b/tcllib/modules/textutil/repeat.man
new file mode 100644
index 0000000..06e23d6
--- /dev/null
+++ b/tcllib/modules/textutil/repeat.man
@@ -0,0 +1,46 @@
+[manpage_begin textutil::repeat n 0.7.1]
+[see_also regexp(n)]
+[see_also split(n)]
+[see_also string(n)]
+[keywords blanks]
+[keywords repetition]
+[keywords string]
+[moddesc {Text and string utilities, macro processing}]
+[titledesc {Procedures to repeat strings.}]
+[category {Text processing}]
+[require Tcl 8.2]
+[require textutil::repeat [opt 0.7]]
+[description]
+
+The package [package textutil::repeat] provides commands to generate
+long strings by repeating a shorter string many times.
+
+[para]
+
+The complete set of procedures is described below.
+
+[list_begin definitions]
+
+[call [cmd ::textutil::repeat::strRepeat] [arg text] [arg num]]
+
+This command returns a string containing the [arg text] repeated
+[arg num] times. The repetitions are joined without characters between
+them. A value of [arg num] <= 0 causes the command to return an empty
+string.
+
+[para]
+
+[emph Note]: If the Tcl core the package is loaded in provides the
+command [cmd {string repeat}] then this command will be implemented in
+its terms, for maximum possible speed. Otherwise a fast implementation
+in Tcl will be used.
+
+[call [cmd ::textutil::repeat::blank] [arg num]]
+
+A convenience command. Returns a string of [arg num] spaces.
+
+[list_end]
+
+[vset CATEGORY textutil]
+[include ../doctools2base/include/feedback.inc]
+[manpage_end]