From 00eaa567cfee6e125748628385d18c93c624aa0c Mon Sep 17 00:00:00 2001 From: Miguel de Benito Date: Sat, 17 Aug 2013 21:39:17 +0000 Subject: [PATCH] Documentation for auto updater. Documentation for advanced preferences. --- devel/scheme/api/api.en.tm | 9 +- devel/scheme/api/automatic-updates.en.tm | 133 +++++++++++++++++++++ devel/scheme/utils/utils-preferences.en.tm | 4 +- main/config/man-advanced-preferences.en.tm | 61 ++++++++++ 4 files changed, 203 insertions(+), 4 deletions(-) create mode 100644 devel/scheme/api/automatic-updates.en.tm create mode 100644 main/config/man-advanced-preferences.en.tm diff --git a/devel/scheme/api/api.en.tm b/devel/scheme/api/api.en.tm index c5650ae..a0c0004 100644 --- a/devel/scheme/api/api.en.tm +++ b/devel/scheme/api/api.en.tm @@ -1,4 +1,4 @@ - + @@ -10,13 +10,15 @@ reading the manual as a book. However it often happens that some module or procedure needs documenting but doesn't fit into any of the available sections of the manual. The purpose of this section is precisely - to assemble all those pieces of information. Currently (sept. 2012) there + to assemble all those pieces of information. Currently (sept. 2013) there are very sketchy pages for: <\traverse> : the file system.|tmfs/tmfs.en.tm> + + team> @@ -28,3 +30,6 @@ with no Back-Cover Texts. A copy of\nthe license is included in the section entitled "GNU Free Documentation License".> + + +> \ No newline at end of file diff --git a/devel/scheme/api/automatic-updates.en.tm b/devel/scheme/api/automatic-updates.en.tm new file mode 100644 index 0000000..22ac849 --- /dev/null +++ b/devel/scheme/api/automatic-updates.en.tm @@ -0,0 +1,133 @@ + + + + +<\body> + + + As of revision 7196, supports automatic notification + of available downloads from a repository and their installation using the + framework for and under + . + + In order to guarantee the origin of releases, these must be signed with a + key, whose public part will be bundled with the application. On + the server side a so-called must be + updated for each release. It is an file containing information + about available downloads, their contents and their digital signatures, + following the specification for /. For the + moment we refer to 's documentation for more details. + + In principle it should be easy for anyone to release their custom versions + of and let their users autoupdate them with a simple change in + the config files. For this they only need provide the public key and the + of the appcast. + + + + Under the process of creation of the appcast is partially + automated through the build rule . Calling + will compile and bundle , then zip and + finally digitally sign the resulting with the script + . In order for this to work, one has to set the + environment variable to point to the location of + the private key used to sign releases. At the end of the build + process a chunk of is printed that can be pasted in the + file. + + Under digital signatures are not yet supported by + and as such will be ignored (Aug. 2013). + + There is no support for automatic notification of releases under + yet. Automatic download and installation is unlikely to happen + due to the way packaging systems work for most distributions. + + + + <\explain> + + <|explain> + Start a background check for updates. A dialog box pops up only if + there's an update. Configuration variables must be properly set for this + call to work. In particular, the appcast url must be set via the + preference . + + + <\explain> + + <|explain> + Start a check for updates immediately popping up a dialog with the + progress. This call is non-blocking at least with and + since they run in separate threads. + + + <\explain> + )> + <|explain> + Sets the interval in hours to wait between automatic checks if these are + activated via . Note that this + alter the value of the preference + , whose use is preferred. + + + <\explain> + )> + <|explain> + Tells whether to automatically check for updates. Note that + this alter the value of the preference + , whose use is preferred. + + + The following preferences determine the behaviour of the automatic update + system: + + <\explain> + )> + <|explain> + The to the appcast which will be used by the startup check. An + empty or undefined value will deactivate both automatic and manual + checks. + + + <\explain> + )> + <|explain> + Whether should automatically look for updates in the background + (some time) after startup. Use to set the + number of hours to wait between checks. + + + <\explain> + )> + <|explain> + How often should look for updates? The interval is given in + hours, with a minimum of one. Setting this to zero deactivates automatic + checks by setting to false. + + + <\explain> + )> + <|explain> + The file with the public key to use to verify the digital + signature of releases. This feature is currently (Aug. 2013) only + supported under , but the preference value is ignored: + will use the value set in the key + in the application bundle's dictionary. + + + team> + + + + + +> \ No newline at end of file diff --git a/devel/scheme/utils/utils-preferences.en.tm b/devel/scheme/utils/utils-preferences.en.tm index a56719e..9f62e91 100644 --- a/devel/scheme/utils/utils-preferences.en.tm +++ b/devel/scheme/utils/utils-preferences.en.tm @@ -1,4 +1,4 @@ - + @@ -38,7 +38,7 @@ <\input|Scheme] > (define (notify-test pref value) - \ \ (display* "Hey! " pref " changed to " value)(newline)) + \ \ (display* "Hey! " pref " changed to " value) (newline)) <\input|Scheme] > diff --git a/main/config/man-advanced-preferences.en.tm b/main/config/man-advanced-preferences.en.tm new file mode 100644 index 0000000..9cc3ad4 --- /dev/null +++ b/main/config/man-advanced-preferences.en.tm @@ -0,0 +1,61 @@ + + + + +<\body> + + + In addition to the , where + most of the important customization may be made, there are some other user + preferences available. These are either too ``fine-grained'' to be added to + the main dialog or simply unsupported and therefore the are only made + accessible through the procedures and + as explained in procedures for user + preferences|../../devel/scheme/utils/utils-preferences.en.tm>. These are + stored, along the rest, in your file. + + + + will color , and source files using + either default colors or the ones you configure with the preferences + where LAN is one of (ok?). + The colors may be either named or hexadecimal as in . + + + + <\explain> + )> + <|explain> + Whether to automatically accept the contents of text widgets in the focus + toolbar upon exit. Setting this to false means one must press the + key to validate the input or it will be lost when the widget + looses focus. + + + <\explain> + )> + <|explain> + Specifies the font size in points of so-called + elements in the interface. These include + the footer and the focus toolbar. Please note that abusing this might + cause some elements in the interface to be misplaced. Reasonable values + are in the range 10-15. + + + + + Please refer to . + + team> + + + + + +> \ No newline at end of file