summaryrefslogtreecommitdiffstats
path: root/doc/ttk_progressbar.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2007-11-01 10:59:40 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2007-11-01 10:59:40 (GMT)
commit83f6db972b3cbb518343cf41b23e9bf959339e8b (patch)
treea9fdb782fb5a267cd0d5385c6d95aae6bd26fe13 /doc/ttk_progressbar.n
parent3ab66bf90c3de1b2ffe2c7eef83f56e189c02337 (diff)
downloadtk-83f6db972b3cbb518343cf41b23e9bf959339e8b.zip
tk-83f6db972b3cbb518343cf41b23e9bf959339e8b.tar.gz
tk-83f6db972b3cbb518343cf41b23e9bf959339e8b.tar.bz2
Make documentation use the name that scripts use as much as possible.
[Bug 1640073]
Diffstat (limited to 'doc/ttk_progressbar.n')
-rw-r--r--doc/ttk_progressbar.n21
1 files changed, 8 insertions, 13 deletions
diff --git a/doc/ttk_progressbar.n b/doc/ttk_progressbar.n
index 3e18c43..7919924 100644
--- a/doc/ttk_progressbar.n
+++ b/doc/ttk_progressbar.n
@@ -4,18 +4,16 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.7 2007/10/29 16:04:14 dkf Exp $
+'\" RCS: @(#) $Id: ttk_progressbar.n,v 1.8 2007/11/01 10:59:43 dkf Exp $
'\"
.so man.macros
-.TH ttk_progressbar n 8.5 Tk "Tk Themed Widget"
+.TH ttk::progressbar n 8.5 Tk "Tk Themed Widget"
.BS
-.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk_progressbar \- Provide progress feedback
+ttk::progressbar \- Provide progress feedback
.SH SYNOPSIS
\fBttk::progressbar\fR \fIpathName \fR?\fIoptions\fR?
.BE
-
.SH DESCRIPTION
A \fBttk::progressbar\fR widget shows the status of a long-running
operation. They can operate in two modes: \fIdeterminate\fR mode shows the
@@ -25,7 +23,6 @@ that something is happening.
.SO
\-class \-cursor \-takefocus \-style
.SE
-
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-orient orient Orient
One of \fBhorizontal\fR or \fBvertical\fR.
@@ -57,17 +54,16 @@ whenever the \fB\-value\fR is greater than 0 and,
in \fIdeterminate\fR mode, less than \fB\-maximum\fR.
This option may be used by the current theme
to provide additional animation effects.
-
.SH "WIDGET COMMAND"
.TP
\fIpathName \fBcget\fR \fIoption\fR
-Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR.
+Returns the current value of the specified \fIoption\fR; see \fIttk::widget(n)\fR.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
-Modify or query widget options; see \fIttk_widget(n)\fR.
+Modify or query widget options; see \fIttk::widget(n)\fR.
.TP
\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR?
-Test the widget state; see \fIttk_widget(n)\fR.
+Test the widget state; see \fIttk::widget(n)\fR.
.TP
\fIpathName \fBstart\fR ?\fIinterval\fR?
Begin autoincrement mode:
@@ -76,7 +72,7 @@ every \fIinterval\fR milliseconds.
If omitted, \fIinterval\fR defaults to 50 milliseconds (20 steps/second).
.TP
\fIpathName \fBstate\fR ?\fIstateSpec\fR?
-Modify or query the widget state; see \fIttk_widget(n)\fR.
+Modify or query the widget state; see \fIttk::widget(n)\fR.
.TP
\fIpathName \fBstep\fR ?\fIamount\fR?
Increments the \fB\-value\fR by \fIamount\fR.
@@ -85,6 +81,5 @@ Increments the \fB\-value\fR by \fIamount\fR.
\fIpathName \fBstop\fR
Stop autoincrement mode:
cancels any recurring timer event initiated by \fIpathName \fBstart\fR.
-
.SH "SEE ALSO"
-ttk_widget(n)
+ttk::widget(n)