summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorKevin Walzer <kw@codebykevin.com>2020-10-05 02:21:47 (GMT)
committerKevin Walzer <kw@codebykevin.com>2020-10-05 02:21:47 (GMT)
commit65ffbd6f047393f5c91afcd9db2bb93f15615a95 (patch)
tree378e65e521209b8d25e761d13cc1c8a9ab1e41e3 /doc
parentf9554b7e3fb28ff1f3af80f88ae5a171adb822b0 (diff)
downloadtk-65ffbd6f047393f5c91afcd9db2bb93f15615a95.zip
tk-65ffbd6f047393f5c91afcd9db2bb93f15615a95.tar.gz
tk-65ffbd6f047393f5c91afcd9db2bb93f15615a95.tar.bz2
Now builds on Mac, still trying to get working; also numerous updates to documentation and script implementation
Diffstat (limited to 'doc')
-rw-r--r--doc/sysnotify.n41
-rw-r--r--doc/systray.n53
2 files changed, 37 insertions, 57 deletions
diff --git a/doc/sysnotify.n b/doc/sysnotify.n
index dbffe07..21bb70e 100644
--- a/doc/sysnotify.n
+++ b/doc/sysnotify.n
@@ -1,34 +1,25 @@
.\" Text automatically generated by txt2man
-.TH untitled "03 October 2020" "" ""
-.RS
-sysnotify n "" Tk "Tk Built-In Commands"
+'\"
+'\" Copyright (c) 2020 Kevin Walzer/WordTech Communications LLC.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+.TH sysnotify n "" Tk "Tk Built-In Commands"
+.so man.macros
.SH NAME
-\fBsysnotify \fP- Creates a notification window with a title and message.
-\fB
+sysnotify \- Creates a notification window with a title and message.
.SH SYNOPSIS
-.nf
-.fam C
-
-\fBsysnotify\fP \fInotify\fP \fItitle?\fP? \fImessage?\fP?
-
-
-.fam T
-.fi
-.fam T
-.fi
+\fBsysnotify\fP \fInotify\fP \fItitle\fP? \fImessage\fR?
+.BE
.SH DESCRIPTION
-
+.PP
The \fBsysnotify\fP command creates a platform-specific system notification alert. Its intent is to provide a brief, unobtrusive notification to the user by popping up a window that briefly appears in a corner of the screen.
.SH EXAMPLE
-
-Here is an example of the \fBsysnotify\fP code:
.PP
-.nf
-.fam C
+Here is an example of the \fBsysnotify\fP code:
+.CS
sysnotify notify "Alert" "This is just a test of the Tk System Notification Code."
-
-.fam T
-.fi
+.CE
.SH KEYWORDS
-
-\fInotify\fP, alert
+notify, alert \ No newline at end of file
diff --git a/doc/systray.n b/doc/systray.n
index c47883b..94e197b 100644
--- a/doc/systray.n
+++ b/doc/systray.n
@@ -1,47 +1,36 @@
.\" Text automatically generated by txt2man
-.TH untitled "03 October 2020" "" ""
-.RS
-systray n "" Tk "Tk Built-In Commands"
+'\"
+'\" Copyright (c) 2020 Kevin Walzer/WordTech Communications LLC.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+.TH systray n "" Tk "Tk Built-In Commands"
+.so man.macros
.SH NAME
-\fBsystray \fP- Creates an icon display in the platform-specific system tray.
-\fB
+systray \- Creates an icon display in the platform-specific system tray.
.SH SYNOPSIS
-.nf
-.fam C
-
-\fBsystray\fP \fIcreate\fP \fIimage?\fP? \fItext?\fP? \fIcallback?\fP?
-\fBsystray\fP \fImodify\fP \fIoption?\fP?
-\fBsystray\fP \fIdestroy\fP
-
-.fam T
-.fi
-.fam T
-.fi
+\fBsystray\fP \fIcreate\fP \fIimage\fP? \fItext\fP? \fIcallback\fR?
+\fBsystray\fP \fImodify\fP \fIoption\fR?
+\fBsystray\fP \fIdestroy\fR
+.BE
.SH DESCRIPTION
-
+.PP
The \fBsystray\fP command creates an icon in the platform-specific tray. The widget is configured with a Tk \fIimage?\fP for the icon display, a string for display in a tooltip, and a \fIcallback?\fP is bound to <Button-1>.
.SH EXAMPLE
-
-Here is an example of the \fBsystray\fP code:
.PP
-.nf
-.fam C
+Here is an example of the \fBsystray\fP code:
+.CS
image create photo book -data R0lGODlhDwAPAKIAAP//////AP8AAMDAwICAgAAAAAAAAAAAACwAAAAADwAPAAADSQhA2u5ksPeKABKSCaya29d4WKgERFF0l1IMQCAKatvBJ0OTdzzXI1xMB3TBZAvATtB6NSLKleXi3OBoLqrVgc0yv+DVSEUuFxIAOw==
systray create -image book -text "Systray sample" -callback {puts "Here is the systray output"}
-
-.fam T
-.fi
-Here is an example of modifying the \fBsystray\fP icon:
+.CE
.PP
-.nf
-.fam C
+Here is an example of modifying the \fBsystray\fP icon:
+.CS
image create book_page -data R0lGODlhCwAPAKIAAP//////AMDAwICAgAAA/wAAAAAAAAAAACwAAAAACwAPAAADMzi6CzAugiAgDGE68aB0RXgRJBFVX0SNpQlUWfahQOvSsgrX7eZJMlQMWBEYj8iQchlKAAA7
systray modify -image book_page
systray modify -text "Updated sample"
systray modify -callback {puts "Different output from the systray"}
-
-.fam T
-.fi
+.CE
.SH KEYWORDS
-
-\fIimage?\fP, \fIcallback?\fP
+image, callback