Next: Introduction [Contents][Index]
| • Introduction | Features and benefits | |
| • Operational Overview | General operational description | |
| • Invoking | Command-line arguments and options | |
| • User Interface | Navigating through the application | |
| • Configuration | Editing the configuration file | |
| • Exercise Log | Log file containing individual records | |
| • Building from Source | Compile the application | |
| • Tech Notes | Technical explanation of METs data | |
| • Technical Support | Make suggestions, report problems. | |
| • Copyright Notice | Boring, but useful. | |
| • Index |
Next: Operational Overview, Previous: Top, Up: Top [Contents][Index]
Exercalc (ecalc) is a console (terminal) dialog-based application built using the author’s NcDialog API (ncurses).
A framework for your daily exercise may be created from a series of configuration options such as height, weight, type of exercise, velocity, intensity and your personal exercise goals. Please See Configuration for details.
Thus, daily/weekly tracking of progress is done simply by entering the daily exercise data in one one of the following forms:
Using the provided information, the application can then calculate additional information. For instance, if you go jogging for thirty minutes at five kilometers-per-hour, the application can calculate the distance convered, the energy expended, the kCalories burned and display that information.
You can compare today’s exercise to another day or to your ideal goal. You can also perform what-if scenarios such as increasing your pace from 5.0kph to 5.5kph to see what the difference would be. Similarly, you could change the number of kCalories burned to determine the pace or time needed to burn that number of kCalories.
You can also view the average of the daily records or graph the data as a bar chart.
┌───────────────────┤ Exercise Statistics ├────────────────────┐ │ Defined Parameters Workout Results │ │ Height (cm) :180.00 Exercise Type : Bicycling │ │ (in) : 70.87 Elapsed Time : 00:55 │ │ Mass (kg) : 81.60 (minutes) : 55 │ │ (lb) : 179.9 Distance (km) : 5.50 │ │ BMI (kg/m²) : 25.19 (mi) : 3.42 │ │ Bicycle METs: 8.00 MET Minutes : 440 │ │ Km/hr : 6.00 kCal Burned : 628 │ │ Mi/hr : 3.73 (mass) (kg) : 0.06981 │ │ kCal/hr :685.44 (lb) : 0.15391 │ │ │ └────────────────────────────────────────────────────────────────┘
An individual exercise record reports the following:
Efficiency calculations for exercise are based on the “Compendium Of Physical Activities” (2011 edition). This database is commonly referred to as the “METs Tables”. The Metabolic Equivalent of Task (MET) is used by physicians, researchers, and health professionals, as well as physical trainers to express the overall efficiency of a given physical activity. The tables include a vast range of physical activity from sleeping, to sitting on the couch to mowing grass to competing in a marathon.
Note: All copies of the METs database we have examined are free of copyright notices or other indicators of a proprietary nature. Thus, to the best of our knowledge, these data are in the public domain.
We do not include the entire database with this application, but the sections on walking, running, bicycling and general cardio exercise are included, translated into the four(4) user interface languages supported by the application. To obtain the full database, please visit one of the following websites:
https://sites.google.com/site/compendiumofphysicalactivities/home
http://prevention.sph.sc.edu/tools/docs/documents_compendium.pdf
For a clear, non-technical description of METs, refer to this Washington
Post article, reprinted in the L.A. Times:
https://www.latimes.com/archives/la-xpm-2005-oct-24-he-mets24-story.html
Disclaimer: This program is provided for informational purposes only.
The author of this application is a software designer, teacher and musician. As such, he has no expertise in physical training, fitness or any medical discipline. He does however regularly track workout activity (yes, he’s a nerd) and has found this application to be useful in daily life.
Exercalc is designed specifically as a teaching tool for the software-design student who wants to create a software application with a user-friendly, multilingual user interface.
As such, a general user may find Exercalc to be lacking polish; however, software engineering students may benefit from the simple, C++ coding style, the algorithms for multilingual support and the source code’s extensive internal documentation.
Author’s Note: This application was written out of boredom caused by the multiple corona-virus quarantines we have endured, both here in China and in the U.S. The author doesn’t much enjoy being around people, but this level of isolation is just ridiculous!
The supported languages for this application were selected simply because they are the languages the author knows. These are all LTR (left-to-right) languages.
The application has been extensively tested using simulated
RTL (right-to-left) data, so it is hoped that adding an RTL user-interface
language will be straightforward.
Please see User Interface Languages for information on integrating
additional user-interface languages
Next: Invoking, Previous: Introduction, Up: Top [Contents][Index]
Exercalc (ecalc) is a simple, console (terminal-window) application, implemented as a dialog using the NcDialog API written by the same author (see by the same author). This API is based on the standard 'ncursesw' library included with all GNU/Linux distributions.
Author’s Note: We apologize that the documentation is available only in English. Software Sam is an engineer and a teacher, not a linguist, so the level of grammar needed to accurately translate this documentation to other languages is beyond his ability. Software Sam is happy to work with other members of the GNU/Linux community to translate the documentation into additional languages.
Nota del autor: Pedimos disculpas por que la documentación sólo esté disponible en inglés. Nuestra capacidad de leer y escribir en otros idiomas limitado. Software Sam está feliz de trabajar con otros miembros de la comunidad GNU / Linux para traducir la documentación a otros idiomas.
作者注：我们深感抱歉，文档仅供参考用英语。
我们用其他语言阅读和写作的能力有限。
很高兴与 GNU / Linux 社区的其他成员合作将文档翻译成其他语言。
Tác giả của Lưu ý: Chúng tôi xin lỗi rằng các tài liệu có sẵn chỉ bằng tiếng Anh. Khả năng đọc và viết bằng các ngôn ngữ khác là hạn chế. Phần mềm Sam là hạnh phúc để làm việc với các thành viên khác của cộng đồng GNU / Linux để dịch các tài liệu sang ngôn ngữ bổ sung.
The Exercalc application is structured as a dialog window (actually a group of three dialog windows) based on the author’s 'NcDialog API', which is in turn based on the 'ncursesw' C-language library which is included with all major GNU/Linux distributions.
Compiling and configuring the application is straightforward. Some experience in compiling Linux programs is helpful, but not necessary. The only external library required is the 'ncursesw' development library.
Please see Building from Source for details.
The default configuration file, 'ecalc.cfg', is located in the same
directory as the Exercalc binary (executable) file. This file specifies
the parameters to be used during the session.
Please see Configuration for details.
For multiple users, an alternate configuration file may be specified
for each user.
Please refer to the '--cfg' option under Invoking
for details.
Many of these configuration parameters may also be specified as command-line options which will override the corresponding value in the configuration file. See the next section for details.
A large number of command-line options are available; however, all options except the input value ('-i' option) are optional. All other configuration data will be taken from the configuration file.
The remaining options may be specified if desired to override the corresponding configuration-file value for the current session only.
Please refer to Invoking for a complete list of command-line options.
The Exercalc user interface is quite simple, consisting of two Pushbutton controls and two menus, one for selecting the activity and the other for modifying exercise-data parameters.
Primary control is through the keyboard’s navigation keys. Mouse support is also available.
The application requires that the terminal window be sized to:
at least 36 rows by 132 columns.
Copying data to and from the system clipboard may be done using the mouse interface with the terminal window, or if communication between the application and the Wayland system clipboard has been established, the currently-displayed data record may be explicitly copied to the system clipboard through a menu option. (see Accessing the System Clipboard)
Please see User Interface for details on navigating within the application dialog window.
Next: User Interface, Previous: Operational Overview, Up: Top [Contents][Index]
OPTION DESCRIPTION 'i' option Input value 't' option Type of exercise 'v' option Rate of speed (kph/mph) 'g' option Display your exercise goal 'height' option Your Height 'mass' option Your Body Mass (weight) 'age' option Your Age 'gender' option Your Gender 'cfg' option Specify alternate configuration filename 'log' option Specify alternate log filename 'l' option Language for user interface 'L' option Locale specification (default: system settings) 'C' option Color Scheme 'a' option Automatic save to logfile 'm' option Enable/disable mouse support (enabled by default) 'p' option Pause to display startup diagnostics 'h' option Display a list of all Exercalc options (short form) 'help' option Display a list of Exercalc command-line options 'version' option Reports the Exercalc version number and copyright info
ecalc [OPTIONS]
All options are optional. Logically, however, the '-i' (Input Value) option should be specified to indicate the basic exercise value to be used in calculating the data record.
For other options which are not specified, the default value will be taken from the configuration file or will be calculated from available data.
If Exercalc is invoked without the '-i' option, the exercise-goal record will be displayed instead (see 'g' option), along with a warning message reminding the user to enter an input value (distance, time or kilocalories).
Options may be specified in any order.
Options are case-sensitive.
Short-form options without arguments or options with one-character arguments may be combined into a single token. (The last option in the list may have a value argument.)
This example indicates: mouse=enable, exercise type=bicycling,
input value=12.4 kilometers.
-metbik=12.4
This example indicates: input value=6 miles, exercise
type=walking, language=Zhongwen (Mandarin Chinese)
-im=6 -twl=Zh
For options which require arguments (excluding those with one-character
arguments), the option must either be joined to its argument using the
EQUAL sign (’=’) with no spaces:
-option=argument
or the argument must be the next token on the command line:
-option argument
(A “token” is a character sequence, delimited by spaces.)
If the argument string contains space characters, it must be enclosed
in either single-quotes ( ' ) or double-quotes ( " ).
--log='week of 20 Aug.log'
--cfg="Echo Liu's.cfg"
Important Note: DO NOT specify time as a decimal value:
Specify time ONLY as hours and minutes: (5:30) or as an integer
number of minutes: (330). A decimal value may be misinterpreted.
For instance, a value of 5.5 WILL NOT be interpreted as five and
one-half hours. It will instead be interpreted as five minutes (with the
fractional minute discarded).
Using an option more than once is strongly discouraged.
If multiple instances of an option appear in the Exercalc invocation,
then the second and subsequent instances may produce unexpected results.
Note on Filenames:
Although under Linux, all printing characters are technically valid
filename characters, certain characters should NEVER be
used as filename characters.
These include: $ { } * and ` (back-tick).
Certain additional characters may be interpreted by the shell program
as having special meaning, and should therefore be avoided. The more
common of these are:
( ) & | ; < > ? " and ' (single-quote)
Author’s Note: Command-line options are implemented in English only, and the switch characters have been selected based on the English words describing the action. During development, we experimented with command-line options in multiple languages, however, the ambiguity and parsing conflicts encountered make multilingual command switches impractical.
The "Input Value" is the amount of exercise performed, and is the only command-line parameter required for generating an exercise record.
This value is used in combination with the default data specified in the configuration file to create the primary exercise record.
If no Input Value is specified, all values of the data record will be set to zero.
Default configuration values may of course be overridden by corresponding command-line options, but the configuration file does not contain a default entry for the input value, so that value must be provided via the ‘-i’ option
The input value indicates one of the following:
- [ k | m ] The distance travelled during the exercise period
(in kilometers or miles)For example, this could be the number of kilometers travelled during your daily run: -ik=4.2
- [ h ] The time elapsed during the exercise period
(in hours and minutes: hh:mm, or as minutes only: mmm)For example, this could be the time you spent on free weights or the time spent weeding the garden: ih=1:45
- [ c ] Number of kilocalories burned during the exercise period
Generally, this value will not be known, and the application will calculate kCalories burned, based on other information. However there are instances where entering this value can be instructive.For example, if you want to know how far you need to walk to burn 500 kCalories, you would enter: -ic=500
Then based on your average walking speed and other factors from the configuration file, the application would then calculate the distance you would need to travel in order to burn 500 kCalories of energy.The “Input Value” is used in conjunction with the data stored in the configuration file, plus any other data specified on the command line to calculate all other display parameters.
As a simple example, if you specify an exercise type of walking, and the distance travelled as 2.0 kilometers:
ecalc -tw -ik=2.0
the application will calculate and display your rate of speed, elapsed time, kCalories burned, METs of energy expended and other information.Please see Configuration for more information.
Invocation Examples
ecalc -ik=13.4 input is 13.4 kilometers ecalc -im 8.0 input is 8.0 miles ecalc -ih=2:10 input is two hours and ten minutes ecalc -ih=90 input is 90 minutes ecalc -ic 325 input is 325 kilocalories
Specify the type of exercise. If not specified on on the command line, the exercise type will be your preferred exercise type specified by the “ExerciseType” entry in the configuration file.
- [ w ] Walking
Specify the exercise type as “Walking”.- [ r ] Running
Specify the exercise type as “Running”.- [ b ] Bicycling
Specify the exercise type as “Bicycling”.- [ g ] General exercise
Specify the exercise type as “General Exercise”.
This includes all other exercise activity such as rowing, yoga, dancing, weight-lifting, gardening, and so on.As an example, if you specify an exercise type of bicycling, and an elapesed time of one hour:
ecalc -tb -ih=1:00
the application will calculate and display the distance travelled, your rate of speed, kCalories burned, METs of energy expended and other factors.Please see Configuration, ExerciseType for more information.
Invocation Examples
ecalc -tw walking ecalc -tr running ecalc -tb bicycling ecalc -tg general exercise
Specify the average velocity for a type of exercise, overriding the value in the configuration file.
Three supported types of exercise (walking/bicycling/running) each have an explicit velocity parameter which may be specified by the 'v' option.
- [ w ] Walking
Specify the average velocity for “Walking”.- [ r ] Running
Specify the average velocity for “Running”.- [ b ] Bicycling
Specify the average velocity for “Bicycling”.The average velocity for each of these exercise types is specified by an entry in the configuration file. The following table shows the correspondence between these configuration values and the values specified through the 'v' option.
PARAMETER EXERCISE TYPE CONFIGURATION OPTION -vw=n.n Walking AverageVelocity_Walk=n.n -vr=n.n Running AverageVelocity_Run=n.n -vb=n.n Bicycling AverageVelocity_Bike=n.n Please see Configuration, AverageVelocity for more information.
Specify the parameters with either KPH units (kilometers-per-hour) or with MPH units (miles-per-hour). If no units are specified, KPH is assumed. Please note that there should be NO space between the decimal value and the specified units.
Invocation Examples
ecalc -vb=12.25mph (average velocity for bicycling = 12.25 mph) ecalc -vw=4 (average velocity for walking = 4 kph) ecalc -vr 5.70kph (average velocity for running = 5.70 kph)
Setting a personal goal for daily or weekly exercise is a practical way to establish a sustainable exercise routine. Your personal goal may be specified using the “Goal” entry in the configuration file.
Please see Configuration, Goal for more information.
The '-g' option instructs the application to immediately display the ideal record for daily ( -gd' ) or weekly ( -gw' ) exercise when the application is opened.
The Goal record may also be displayed through the menu.
Please see Display Exercise Goal for more information.Invocation Examples
ecalc -gd (display the Daily goal) ecalc -gw (display the Weekly goal)
Specify your height in centimeters, meters or inches.
If units are not specified, centimeters is assumed.This value is used to calculate the BMI (Body Mass Index).
A value specified using the “--height” option will override the value specified in the configuration file.
Please see Configuration for more information.
Invocation Examples
ecalc --height=180cm (height: 180 centimeters) ecalc --height=174 (height: 174 centimeters) ecalc --height 1.62m (height: 1.62 meters) ecalc --height=72in (height: 72 inches)
Specify your mass (weight) in kilograms or pounds.
If units are not specified, kilograms is assumed.This value is used to calculate the METs of energy expended during exercise as well as the BMI (Body Mass Index).
A value specified using the “--mass” option will override the value specified in the configuration file.
Please see Configuration for more information.
Invocation Examples
ecalc --mass=74kg (mass: 74 kilograms) ecalc --mass 76.5 (mass: 76.5 kilograms) ecalc --mass=142.3lb (mass: 142.3 pounds)
Specify your age in years.
The standard METs tables reflect an average of all subjects tested. By specifying your age, the tables may be adjusted to more accurately reflect data for your age range.
A value specified using the “--age” option will override the value specified in the configuration file.
Please see Configuration for more information.
Invocation Examples
ecalc --age=21 (age: 21 years) ecalc --age 32 (age: 32 years) ecalc --age=16.5 (age: 16 years + 6 months) ecalc --age=84.679 (age: 84 years + 248 days (248/365))
The standard METs tables reflect an average of all subjects tested. By specifying your gender, the tables may be adjusted to align more closely with the observed results of scientific studies.
Specify gender as one of the following: 'f' (female), 'm' (male), 'o' (other).
A value specified using the “--gender” option will override the value specified in the configuration file.
Please see Configuration for more information.
While for many people gender identification is fairly straightforward, for others gender is a more fluid concept. No need to worry though—just choose a value that feels right to you.
Invocation Examples
ecalc --gender=female ecalc --gender=f ecalc --gender male ecalc --gender=other
The default configuration file is 'ecalc.cfg' and is located in the same directory as the application binary (program file).
The default configuration file may be edited to provide the most-often-needed setup parameters.
An alternate configuration file may be specified for special circumstances, or to provide personalized setting when multiple users share the same system.
To create an alternate configuration file, simply copy the default configuration file to a convenient location and make the desired modifications to its parameters.
Please see Configuration for details.The '--cfg' option can then be used to specify the location and filename of the new configuration file.
Invocation Examples
ecalc –cfg=Vacation.cfg ecalc –cfg HealthClub.cfg ecalc –cfg="~/Documents/Iron Man Competition.cfg"
Specify an alternate location, alternate filename or alternate format for the output log.
By default, the log file is written to the CWD (Current-Working-Directory) directory, that is, the directory from which the application was launched. If you are not sure of the CWD in the terminal window, type: 'pwd'.
By default, the base log filename is “ecalc_log” with the filename extension either “.txt” (indicating plain-text output), or “.html” (indicating HTML-format output).
The target log file may also be specified in the configuration file.
Please see Configuration, LogfilePath for details.A file specified using the '--log' option will override the value specified in the configuration file. If the filename extension is '.html', then the output will be in HTML format. Otherwise, the output will be in plain-text format.
Invocation Examples
ecalc --log=’Exercise for April.txt’ log file in plain text format ecalc --log=’Free Weights.log’ log file in plain text format ecalc --log ./April/ecalc.html log file in HTML format
Specify the language for the user interface.
By default, the user interface language is determined by the locale set in the terminal program’s environment. If your system is configured for an unsupported language, the user interface will default to English.
Use the 'l' option to specify a non-default user interface language. Exercalc currently supports the following languages.
- English
- Español (Spanish)
- Zhōngwén (中文) (Chinese, simplified)
- Tiếng Việt (Vietnamese)
The language may also be set through the configuration file.
Please see Configuration, Language for details.Invocation Examples
To specify the language, only the first two characters of the language name are necessary. In general, the first two characters of the language correspond to the ISO-639-1 language definition: Español (es), Zhōngwén (zh), English (en), Tiếng Việt (vi). Argument is not case sensitive.
ecalc -l=Zhongwen ecalc -l ZH ecalc -l=Zh -L=zh_CN.utf8
Note that the system’s locale must support UTF-8 character encoding in order to fully display the character set of the target language. For additional information on the system locale, see 'L' option below.
The system locale provides information on how text input and output will be interpreted and displayed.
The locale specifies not only the primary user interface language, but also the character encoding used, the format for time, currency, numeric formats, units of measurement and more.
Most, if not all modern GNU/Linux distributions default to a locale which uses UTF-8 character encoding so that all characters in all languages may be displayed.
The Exercalc application will scan the terminal environent for the system default locale, and if found will use the specified language and text formatting by default. Therefore it is usually unnecessary to directly specify a locale. If, however the displayed text is not formatted correctly or if unexpected characters are mixed with the data, then it is likely that you will need to specify the locale to be used.
To determine the locale used by your system, open a terminal window and type the following command:
locale -v (ENTER)
For United States English, something like the following will be displayed.
[Exercalc]$ locale -v LANG=en_US.utf8 LC_CTYPE="en_US.utf8" LC_NUMERIC="en_US.utf8" LC_TIME="en_US.utf8" LC_COLLATE="en_US.utf8" LC_MONETARY="en_US.utf8" LC_MESSAGES="en_US.utf8" LC_PAPER="en_US.utf8" LC_NAME="en_US.utf8" LC_ADDRESS="en_US.utf8" LC_TELEPHONE="en_US.utf8" LC_MEASUREMENT="en_US.utf8" LC_IDENTIFICATION="en_US.utf8" LC_ALL=It can be seen that the locale is set to en_US.utf8.
The language is (usually) specified by either the two-character code according to the ISO-639-1 standard (Example: en), or the three-character code according to the ISO-639-2 standard.
The country is specified as a two-character code according to the ISO-3166-2 standard (Example: US)Non-UTF-8 locales may be named in semi-random ways, but should be avoided as much as possible.
To list all the locales available on your system type the following command:
locale -a (ENTER)
Any locale which supports UTF-8 encoding may be specified for use with the Exercalc application.
locale -a | grep -i 'utf8' (ENTER)
The locale may also be set through the configuration file.
Please see Configuration, Locale for details.Invocation Examples
The locale may be specified alone or in conjunction with a language specification.
Note that because locale names are actually filenames, the argument IS case sensitive.
ecalc -L=zh_CN.utf8 ecalc -L vi_VN.utl8 ecalc -L=es_MX.utf8 -l=Es
The Exercalc application is implemented as a dialog window. The colors used for this dialog, its contents, and the various sub-dialogs may be specified by selecting the desired color scheme.
The available options are:
'black' 'red' 'green' 'brown' (default) 'blue' 'magenta' 'cyan' 'gray'The default color scheme uses a basic brown text on the default background (usually off-white), with high-contrast colors for the dialog’s contents and interface controls.
The "reverse" sub-option is available for launching the application in terminal windows which are configured with a dark background color.
The "reverse" sub-option may optionally be appended to the color-scheme specification, seperated by a comma (no spaces).Actual functionality is identical for all color schemes, so choose the color scheme that you find most pleasing.
The color scheme may also be specified in the configuration file.
Please see Configuration, ColorScheme for details.Invocation Examples
ecalc -C=blue ecalc -C magenta ecalc -C=blue,reverse ecalc -C=green,r
This option is used to automatically save the primary record when the application exits.
The primary record is the record created from the input value see 'i' option and other data during application startup.
If the user has explicitly saved the primary record via the user-interface controls, then the record will not be saved again when exiting the application.
The auto-save feature may also be activated in the configuration file.
Please see Configuration, LogfileAuto for details.Invocation Examples
ecalc -a=enable ecalc -a disable
The user interface for Exercalc is a very simple one which can easily be controlled through the keyboard’s navigation keys: TAB, Shift+TAB, arrow keys, page-up, page-down and Enter. For this reason, enabling the mouse interface is of limited value. However, the mouse interface is fully functional and can be enabled and disabled through a configuration option.
Use the '-m' option to enable or disable the mouse interface for the current session. This will override the setting in the configuration file.
Please see Configuration, EnableMouse for details.Mouse support for a console program is subject to many technical issues. Therefore, the application requires a mouse with at least one button AND a scroll wheel. If your mouse does not have a scroll wheel (or scroll-wheel emulation), then mouse support cannot be enabled.
See Special Note on Mouse Support, for a discussion of using the mouse to copy text data to the system clipboard.
Invocation Examples
ecalc -m=disable ecalc -m enable
This option may be used to pause briefly during the startup sequence so that the startup diagnostic messages can be read.
The application writes certain diagnostic data to the console window during the startup sequence which is immediately overwritten when the application dialog opens. The 'p' option inserts a small delay (approximately four(4) seconds) between completion of the startup sequence and opening the application dialog.
This is useful if the application encounters memory allocation errors, file access errors, detection of an unsupported language or locale, or other system configuration problems.
The 'p' option also has a ‘verbose’ sub-option which will display much more information — specifically it will display the value for each entry in the configuration file — and will then wait for a keypress before opening the application dialog. While verbose diagnostics are used primarily during application development, they are also useful for identification of syntax or other errors in the configuration file.
Invocation Examples
ecalc -p (4-second pause) ecalc -pv (verbose diagnostics, wait for Enter key)
This is the short form of the 'help' option, below.
Invocation Examples
ecalc -h
Command-line Help. Display a brief summary of command-line usage and options. (overrides everything on command line except '--version')
Invocation Examples
ecalc --helpAlso see 'h' option, for short-form help option.
Display the application version number and copyright information. (overrides everything else on command line)
Invocation Examples
ecalc --version
An additional command-line option, --rtl is defined for use during application development. This option renders the English text as if it were an RTL language. This allows for testing of the various RTL flags and offsets in the user-interface code. Invoking with the --rtl option makes the English text rather difficult to read, but since the author reads Chinese for a living, a simple: “deifidoM eB oT retemaraP a tceleS” is not that much of a problem. :-)
Please see RTL language support for details.
Next: Configuration, Previous: Invoking, Up: Top [Contents][Index]
| • Application Layout | Description of application features | |
| • Dialog Controls | Notes on using interface controls effectively |
Next: Dialog Controls, Up: User Interface [Contents][Index]
Exercalc (ecalc) is a console (terminal window) application based on the author’s NcDialog API (Application Programmer’s Interface). The API is based on the standard GNU/Linux 'ncurses' (actually 'ncursesw') C-language library.
The application dialog is made up of three(3) sub-dialogs which are simultaneously displayed within the terminal window.
The initial statistics display is constructed from the command-line
arguments combined with the setup data from the configuration file.
These data may be modified or supplanted by other data records.
Please see Daily Exercise Record in the Introduction for a
description of the individual elements of the statistics display.
The user-interface controls provide various options for modifying,
formatting and storing the exercise statistics.
See Dialog Controls, below.
The primary function of this dialog is to display the METs Tables associated with the record currently displayed in the Statistics window.
This window is used to display several other types of data depending
upon the selected data operation.
See Dialog Controls, below.
The application requires that the terminal window be at least:
36 rows by 132 columns
If the terminal window is too small, the application dialog will not
open, and an error message will be displayed and will wait for a
keypress before exiting.
If the terminal window is resized while the error message is displayed,
the application will report the new terminal dimensions. This functionality
is included as a convenience due to the short-sighted design decision
by the Gnome-terminal group to no longer report the terminal dimensions as
the window is resized. (Bad gnome-term group! Go to your room.)
In contrast, Konsole faithfully continues to report the dimensions as the
terminal window is resized. (Have a Scooby snack, Konsole team!)
Previous: Application Layout, Up: User Interface [Contents][Index]
Navigating through the dialog windows, menus and other application controls is done through the keyboard, the mouse or a combination of the two.
The keyboard navigation keys: Up/Down/Left/Right Arrows, Home, End, PageUp,
PageDown, along with Tab, Shift+Tab, the Spacebar and Enter keys are used
to move among the controls and within the individual controls.
Please refer to the NcDialog API documentation for a complete description
of the keyboard interface.
Mouse support is generally not needed for such a simple application, and is disabled by default. Mouse support may be enabled either through a configuration option, (Configuration), or as a command-line option, (Invoking).
The mouse may be used to control the user interface or for
copy-and-paste operations, but not both. We have found it useful to copy
text from the application dialog to other documents, so by default,
we allow the desktop to retain control of the mouse. Note however that
if communication between the application and the Wayland system clipboard
has been established, (Accessing the System Clipboard) the
currently-displayed data record may be explicitly copied to the system
clipboard through a menu option.
Please see the “Clipboard Interface” chapter of the NcDialog API
documentation for a description of the Wayland clipboard interface. See
also the “Copy Cut and Paste Operations” section of that chapter for
a tutorial on using the mouse to interface with the system clipboard.
Two Pushbutton controls are defined in the main dialog window.
The "Close Dialog" Pushbutton performs the application’s shutdown sequence and exit the application.
If specified, the shutdown sequence includes writing the exercise record to the log file (if it has not already been saved). Refer to the description of the "LogfileAuto" option of the configuration file Configuration,
The "Save To Log File" Pushbutton writes the currently-displayed exercise record to the log file.
The displayed record is written to the log, in generally the same format
as displayed in the dialog.
Please see Exercise Log for details.
One Dropdown control is defined. This control is an expanding menu which allows each dynamic parameter of the exercise record to be modified. These modifications enable the user to create various “what-if” scenarios to assist in structuring the daily exercise program.
The items available in the Dropdown menu are described below.
For example, to compare the Kcalories burned by walking during the exercise period with the Kcalories that would be burned while bicycling during the same period.
Prompt:
For example, if during an exercise period of 30 minutes, you covered a distance of 3.5 kilometers, you could ask the application to calculate the distance you would cover in 2:00 hours at the same pace.
Prompt:
For example, if during a 45-minute exercise period you covered 4.5
kilometers (6.00 kph), you could enter a new distance, and the
application would calculate how long it would take at that same pace
to cover the specified distance.
Entering a new distance of 8.0 kilometers, it would require 1:20 at
the same pace to cover the distance.
Technical Note: To adjust the pace, modify the METs value associated with the type of exercise. (see below)
Prompt:
The configuration file contains METs tables for each type of exercise. Refer to the descriptions of the activity found in these tables which matches the intensity of your activity.
For instance, referring to the METs table for bicycling displayed in the application dialog screenshot:
The various levels of intensity are encoded in the given METs values.
Modify the METs value to see how the change in exercise intensity
affects the efficacy of the exercise.
Prompt:
It may also be useful to modify the Body Mass parameter experimentally to view how it affects the efficiency of the exercise. For instance, a change in body mass will affect the number of Kilocalories burned during a given exercise period.
Prompt:
For example, if the current record shows that you walked 4.0 kilometers and burned 220 Kcal, to determine how far you would need to walk in order to burn 500 Kcal, enter 500, and the application will calculate the distance in kilometers (and miles) needed to burn 500 kilocalories. In this example, walking 8.98 kilometers would consume 500 Kcal.
Prompt:
Prompt:
A message: “Original parameters restored.” will be displayed to indicate that the operation was successful.
If you will want to retrieve the dicarded record at a later time, save it to the log file before selecting the Discard Modifications command. (see Write Record to Log)
One Menuwin control is defined. This is a standard menu which provides operations for managing the exercise log file (see Exercise Log). Miscellaneous additional options are also included. The items available in the Menuwin menu are described below.
The individual records are displayed in the Data Display window, one
record per line. Highlight the desired record and press the
“Select” Pushbutton. The selected record will then be
displayed in the Exercise Statistics window.
See the screenshot below: Select-record Dialog.
The currently displayed record may be an experimental record created through user interaction, a record retrieved from the log file, the "Goal" record, or another record source.
Select-record Dialog
┌────────────────┤ Select Log File Record ├─────────────────┐ │ Date Duration ExerciseType Distance METs kCal │ ├───────────────────────────────────────────────────────────────┤ │2021-05-31 01:10 Bicycling 07.00km 560.0 897.68 │ │2021-06-01 01:06 Bicycling 06.60km 528.0 846.38 │ │2021-06-02 01:02 Bicycling 06.20km 496.0 795.09 │ │2021-06-03 00:58 Bicycling 05.80km 464.0 743.79 │ │2021-06-04 00:54 Bicycling 05.40km 432.0 692.50 │ │2021-06-05 00:50 Bicycling 05.00km 400.0 641.20 │ │2021-06-06 00:46 Bicycling 04.60km 368.0 589.90 │ │2021-06-07 00:42 Bicycling 04.20km 336.0 538.61 │ │2021-06-08 00:42 Bicycling 04.20km 336.0 538.61 │ │2021-06-09 00:46 Bicycling 04.60km 368.0 589.90 │ │2021-06-10 00:50 Bicycling 05.00km 400.0 641.20 │ │2021-06-11 00:54 Bicycling 05.40km 432.0 692.50 │ │2021-06-12 00:58 Bicycling 05.80km 464.0 743.79 │ │2021-06-13 01:02 Bicycling 06.20km 496.0 795.09 │ │2021-06-14 01:06 Bicycling 06.60km 528.0 846.38 │ │2021-06-15 01:10 Bicycling 07.00km 560.0 897.68 │ │2021-06-16 01:14 Bicycling 07.40km 592.0 948.98 │ │2021-06-17 01:18 Bicycling 07.80km 624.0 1000.27 │ │2021-06-18 01:18 Bicycling 07.80km 624.0 1000.27 │ │2021-06-19 01:14 Bicycling 07.40km 592.0 948.98 │ │2021-06-20 01:10 Bicycling 07.00km 560.0 897.68 │ │2021-06-21 01:06 Bicycling 06.60km 528.0 846.38 │ │2021-06-22 01:02 Bicycling 06.20km 496.0 795.09 │ ├───────────────────────────────────────────────────────────────┤ │ Number of Records: 56 │ │ Highlight the desired record and then press "Select". │ │ │ │ Select Cancel │ │ │ └───────────────────────────────────────────────────────────────┘
Help About Dialog
╔═══════════════════════╣ About Exercalc ╠═══════════════════════╗ ║ Exercalc: Exercise-analysis application and demo program for ║ ║ development of a multilingual user interface. ║ ║ Version: 0.0.01 ║ ║Copyright: (c) 2020-2021 Mahlon R. Smith, The Software Samurai ║ ║ Beijing University of Technology - Beijing, PRC ║ ║ 马 伦 教 授 北 京 工 业 大 学 - 北 京 ， 中 华 人 民 共 和 国 ║ ║ ║ ║Development: Fedora Linux 32 -- GNU G++ (Gcc v: 10.2.1) ║ ║Licensing : GNU General Public License, version 3, ║ ║ GNU Free Documentation License, version 1.3 ║ ║ ║ ║ For bugs or enhancement requests, please contact the author at: ║ ║ http://www.SoftwareSam.us/ ║ ║ ║ ║ CLOSE SUPPORT INFORMATION ║ ╚════════════════════════════════════════════════════════════════════╝
Tech Support Request
╔═══════════════╣ Technical Support Information ╠════════════════╗ ║ Please include this information Compiler: ║ ║ with all tech support requests. g++ (GCC) 10.3.1 2021042║ ║ NcDialog API library : 0.0.33 Dynamic (shared) Libs: ║ ║ libncursesw.so.6 ║ ║ ncursesw library : 6.2.20200222 libtinfo.so.6 ║ ║ libstdc++.so.6 ║ ║ Locale setting : en_US.UTF-8 libm.so.6 ║ ║ (English) libgcc_s.so.1 ║ ║ libc.so.6 ║ ║ Saved to: Exercalc_SupportRequest.txt libdl.so.2 ║ ║ SAVE TO FILE CLOSE ║ ╚══════════════════════════════════════════════════════════════════╝
When submitting a request for technical support, it is helpful for that request to include certain information about the application and the system on which it is running.
This information is collected in a sub-dialog which is invoked by pressing the 'SUPPORT INFORMATION' pushbutton in the Help About dialog.
Pressing the 'SAVE TO FILE' pushbutton will save this information
to a plain-text file in the current working directory (CED) which can be
edited to add specific information related to the technical support request.
The contents of this file can then be copied into the body of an email.
Also, see Technical Support for more information.
Next: Exercise Log, Previous: User Interface, Up: Top [Contents][Index]
The configuration file provides default values for all operational parameters, and may be customized using any plain-text editor to provide the desired setup values to be loaded on application startup.
The configuration file is fully self-documenting, so it is hoped that selection of parameters will be straightforward.
The available options are:
Examples:
Height=1.785 No units specified, meters is assumed.
Height=1.785m meters
Height=178.5cm centimeters
Height=70.3in inches
Examples:
BodyMass=74.0 No units specified, kilograms is assumed.
BodyMass=74.0kg kilograms
BodyMass=163.2lb pounds
Examples:
Age=34.0
Age=41
Age=16.5
Examples:
Gender=Male
Gender=Male
Gender=Other default value
Examples:
ExerciseType=Walk default value
ExerciseType=Bike
ExerciseType=Run
ExerciseType=General
Velocity may be specified in either Kilometers-Per-Hour: "kph" or in
Miles-Per-Hour: "mph". If units are not specified, kilometers-per-hour is
assumed.
For command-line override, see 'v' option.
Examples:
AverageVelocity_Bike=15.5 default: 19.31 kph (12.0mph)(8.0 METS)
AverageVelocity_Walk=4.2kph default: 5.63 kph ( 3.5mph)(3.8 METS)
AverageVelocity_Run=6.6mph default: 12.87 kph ( 8.0mph)(8.0 METS)
There is no direct command-line override for this group of configuration options.
Examples:
Walk_METs=3.5 default: 3.3 METs,
"3.0 mph, level, moderate pace, firm surface",
Bike_METs=8.5 default:8.0 METs, "bicycling general"
Run_METs=11.5 default: 7.0 METs, "jogging, general"
General_METs=6.0 default: 5.5 METs,
"health club exercise, general"
If your goal is the combination of multiple exercise types, then specify the amount of exercise as elapsed time.
For command-line override, see 'g' option.
Examples:
Note that parameters are separated by spaces.
If no goal is specified, then the default value will be used, which is:
30 minutes of walking per day with an intensity of 3.3 METs.
Expressed as: "Goal = Daily 0:30 3.3mets"
If the filename extension is ".html", the data will be saved in HTML format. Otherwise, the data will be saved as plain text.
For command-line override, see 'log' option.
Examples:
$HOME/Documents/Exercise/DailyExercise.txt (save as text)
~/Documents/Exercise/DailyExercise.html" (save as HTML)
./DailyExercise.txt (save as text to CWD)
./DailyExercise.html (save as HTML to CWD)
For command-line override, see 'a' option.
Examples:
LogfileAuto = disable Disable automatic save (default)
LogfileAuto = enable Enable automatic save on exit
By default, the language for the user interface is automatically determined based on the “locale” specified by the terminal environment. Example: LANG=en_US.UTF-8
The language specified must be supported by the terminal environment’s locale. If not, then some characters may be rendered incorrectly. Any UTF-8 compliant locale will render most text correctly for any language, but see the ’Locale’ option below.
The following parameters are available for this option:
For command-line override, see 'l' option.
Examples:
Language = None specified, defaults to locale
Language = locale use language from terminal environment
Language = Espanol Spanish
Language = Zhongwen Mandarin (Beijing dialect) Chinese
Language = TiengViet Vietnamese
Language = English English
The following parameters are available for this option:
For command-line override, see 'L' option.
Examples:
Locale = locale taken from environment
Locale = es_MX.utf8 (Espanol - Mexico)
Locale = zh_CN.utf8 (Zhongwen - mainland China)
Locale = vi_VN.utf8 (TiengViet - Vietnam)
Locale = en_US.utf8 (English - United States)
The Color Scheme is the combination of text colors and background colors used to draw the application’s dialog windows.
The Color Scheme allows selection of a set of complementary display colors to be used when drawing borders, dialog windows, menus, and other dialog objects.
The following parameters are available for this option:
A secondary option is available for launching the application in
terminal windows which are configured with a dark background color.
Although the Exercalc application’s foreground/background color schemes
are designed primarily for terminal windows which are configured for
dark text on a white or pastel background, the “reverse”
sub-option may be used to reverse (swap) the foreground and background
for the first eight(8) color pairs. While this does not yield a
truly attractive display, it does at least provide enough contrast to
make the text data readable.
It is recommended that the application be launched in a terminal-window
using a profile with dark text on a light background; however, if that
is not practical, the "reverse" sub-option may be specified.
For command-line override, see 'C' option.
Examples:
ColorScheme = none specified, defaults to ‘brown’
ColorScheme = black black text
ColorScheme = green green text
ColorScheme = blue,reverse blue on reversed terminal background
ColorScheme = blue,r (same as above)
Exercalc is a very simple application and full functionality is available through the keyboard interface. If desired, however, the mouse interface may be enabled for interacting with the various application menus, pushbuttons and other application controls.
Also see Special Note on Mouse Support for information on using the system mouse for copy-and-paste operations.
To activate the mouse interface, the mouse must have at least one button and a ScrollWheel (or scroll-wheel emulation).
A Left Button click is generally interpreted as selecting the item under the mouse pointer i.e. the field to be edited or one of the user-interface controls (menus, pushbuttons, etc.)
The ’Ctrl’, ’Shift’ or ’Alt’ modifier keys when pressed in combination with a mouse click or ScrollWheel event will modify the interpretation of the action. All other mouse events will be ignored.
For a full description of the mouse interface, please see the “Mouse Configuration” chapter of the NcDialog API documentation.
For command-line override, see 'm' option.
Examples:
EnableMouse = not specified, defaults to ‘disable’
EnableMouse = enable enable mouse support
EnableMouse = disable disable mouse support
Next: Building from Source, Previous: Configuration, Up: Top [Contents][Index]
The exercise log may be used to store exercise records for later review. Any exercise record may be saved to the log file.
The records may then be summarized, or an individual record may be retrieved for review.
The record may be saved either through the “Save To Log File”
Pushbutton, or via the “Write Record to Log” menu option.
Please see Dialog Controls for more information.
In either case, a dialog is displayed asking for confirmation before writing to the log file. This dialog also offers the option of adding a short comment to the record.
┌─────────────────┤ Save Record To Log File ├──────────────────┐ │ Save the currently-displayed record to the log file? │ │ Optionally enter a comment to be saved with the record. │ │ │ │ Best workout this month! │ │ Comment Text │ │ Save Record Cancel │ └────────────────────────────────────────────────────────────────┘
The log file is formatted according to the filename extension of the target
file. If the filename extension is ".html", the data will be written
as an HTML document. For any other filename extension, the data will be
written as plain text.
See Configuration, LogfilePath, on specifying the log filename.
Within the log file, each data record is stored in two formats.
Record in Text Format
2021-06-08T16:41:30 - Best workout this month! Defined Parameters Workout Results Height (cm) :179.07 Exercise Type : Bicycling (in) : 70.50 Elapsed Time : 01:00 Mass (kg) : 70.20 (minutes) : 60 (lb) : 154.8 Distance (km) : 6.00 BMI (kg/m²) : 21.89 (mi) : 3.73 Bicycle METs: 8.00 MET Minutes : 480 Km/hr : 6.00 kCal Burned : 589 Mi/hr : 3.73 (mass) (kg) : 0.06552 kCal/hr :589.68 (lb) : 0.14445 ###: 1.791:70.200:21.892:5.70:6.00:6.80:3.30:8.00:7.00:5.50:6.000: 6.000:3.728:60:8.00:8.00:6.000:480.000:589.680:01:02:60BFD5FAHTML Container
<!DOCTYPE HTML> <html> <head> <!-- # EC_LOG: Exercalc: Log File --> <!-- Created: 2021-06-08T16:52:17 Exercalc, written by The Software Samurai --> <meta charset="utf-8" /> <!-- Import the global stylesheet --> <link rel="stylesheet" href="infodoc-styles.css" lang="en" type="text/css"/> </head> <body> <div class="curses_container"> <!-- RECORD IN HTML FORMAT IS WRITTEN HERE --> <!-- ###: 1.791:70.200:21.892:5.70:6.00:6.80:3.30:8.00:7.00:5.50:6.000: 6.000:3.728:60:8.00:8.00:6.000:480.000:589.680:01:02:60BFD8B7 --> <br> <!-- End User Data --> <br></div><!-- (end curses_container class) --> </body> </html>Record in HTML Format
2021-06-08T16:53:11 Best workout this month! ┌───────────────────┤ Exercise Statistics ├────────────────────┐ │ Defined Parameters Workout Results │ │ Height (cm) :179.07 Exercise Type : Bicycling │ │ (in) : 70.50 Elapsed Time : 01:00 │ │ Mass (kg) : 70.20 (minutes) : 60 │ │ (lb) : 154.8 Distance (km) : 6.00 │ │ BMI (kg/m²) : 21.89 (mi) : 3.73 │ │ Bicycle METs: 8.00 MET Minutes : 480 │ │ Km/hr : 6.00 kCal Burned : 589 │ │ Mi/hr : 3.73 (mass) (kg) : 0.06552 │ │ kCal/hr :589.68 (lb) : 0.14445 │ │ │ └────────────────────────────────────────────────────────────────┘
Next: Tech Notes, Previous: Exercise Log, Up: Top [Contents][Index]
The Exercalc application is written in C++ and is built with the GNU C++ compiler and linker.
Additional libraries and tools:
As of this writing (March 2021), ncursesw v:6.2.20200222 has proved to be stable. If you are using an older version, it is strongly recommended you update to this version or newer.
Instructions for building the library are included with the NcDialog API package.
While access to the system clipboard is not necessary, it can be convenient for copy-and-paste of data records to other applications. Please refer to the “Wayland Clipboard Interface” chapter of the NcDialogAPI documentation for additional information on downloading and installing the “wl-clipboard” utilities.
This copy operation is built into the Makefile which uses the 'rsync' utility to refresh the needed files.
gmake refreshlib
If you did not install the source for the two packages at the same
directory level, then the 'rsync' call will fail, and you will have
to copy the needed files manually. Copy the following files:
The “DEBUG_MENU” conditional compile option enables or disables various code used during development and testing of the application. Because the Exercalc application is primarily a tool for understanding and building multilingual user interfaces, this option is enabled by default.
The “DEBUG_RTL” conditional compile option allows the English-language text to be displayed as if it were an RTL (right-to-left) language. This is handled through the debugging-only --rtl command-line option. This option allows for debugging the application’s RTL language support. Because the Exercalc application is primarily a tool for understanding and building multilingual user interfaces, this option is enabled by default.
The definitions for these options are located in Exercalc.hpp.
To test the build, invoke with a request for the Exercalc version number. You should get something similar to the following:
For the Exercalc application to be visible throughout your system, you will need to place the executable file (or a symbolic link to it) in a directory on your execution path.
These five(5) files must be placed in the same directory, and the executable file must be visible on the execution path.
ecalc the binary (executable) file
ecalc.cfg the configuration file
exercalc.info the documentation file (info-reader format)
exercalc.html the documentation file (HTML format)
infodoc-styles.css the CSS style definitions for HTML
To see your execution path, type:
echo $PATH
/usr/local/bin:/usr/bin:/bin:/usr/local/sbin:
/usr/sbin:/home/sam/.local/bin:/home/sam/bin
The directories on the execution path are separated by the colon ':' character. Generally, it is recommended that you choose the last entry in the list because that directory belong only to you.
There are several diferent ways to perform the installation. All are
equally valid, but some are more easily maintained than others. It is
recommended that the above files be copied to a directory where you
normally install applications, and that a “symbolic link”
(symlink) to the executable file be created in the desired directory on
the execution path. For example, the author normally installs
applications in the directory '/home/sam/Apps'. The installation would then
follow the pattern shown (substituting your own user name and source
directory path).
Note that the tilde character '~' is a shorthand way of specifying
your home directory. '~' is equivalent to '/home/sam'
Create the target directory:
mkdir --parents ~/Apps/Exercalc
Go to the source directory:
cd ~/SoftwareDesign/Exercalc
Copy the files to the target directory:
cp --preserve ./ecalc ~/Apps/Exercalc/.
cp --preserve ./ecalc.cfg ~/Apps/Exercalc/.
cp --preserve ./exercalc.info ~/Apps/Exercalc/.
cp --preserve ./exercalc.html ~/Apps/Exercalc/.
cp --preserve ./infodoc-styles.css ~/Apps/Exercalc/.
Go to the target directory:
cd ~/Apps/Exercalc
Create a symbolic link on the execution path:
cp --symbolic-link ./ecalc ~/bin
Alternatively, the five source files could all be copied to the
directory on the execution path:
cp --preserve ./ecalc ~/bin/.
cp --preserve ./ecalc.cfg ~/bin/.
cp --preserve ./ecalc.info ~/bin/.
cp --preserve ./ecalc.html ~/bin/.
cp --preserve ./infodoc-styles.css ~/bin/.
Alternatively, symbolic links to these files (not including
the CSS style definitions) may be placed on the execution path:
cp --symbolic-link ./ecalc ~/bin/.
cp --symbolic-link ./ecalc.cfg ~/bin/.
cp --symbolic-link ./exercalc.info ~/bin/.
cp --symbolic-link ./exercalc.html ~/bin/.
Note on temporary files: Exercalc creates various temporary files during execution. Exercalc queries the system for the directory where temporary files are to be created. If the specified directory cannot be found, then Exercalc cannot safely create temporary files, and a diagnostic message will be displayed:
ERROR: Directory for creating temporary files is inaccessible.
For more information on temporary files, please see the documentation for the 'tmpnam_r' C-language function or the coreutils 'mktemp' utility.
Documentation for Exercalc is provided in both Texinfo (info) format and HTML format.
To view the HTML-format documentation, navigate to:
Exercalc/Texinfo
then load the 'exercalc.html' document into your favorite browser.
xdg-open exercalc.html
Note that the 'infodoc-styles.css' CSS style definition file
must be in the same directory as the HTML document.
To view the Texinfo (info) documentation, navigate to:
Exercalc/Texinfo
then view the documentation using the following command:
info -f exercalc.info
Follow these steps to install the Exercalc documentation into the ‘info’ database.
sudo find /usr/local -name dir
For local users, this is typically:
/usr/local/share/info/dir
For multi-user systems, this is typically:
/usr/share/info/dir
This will open the top-level menu of the Info system.
Verify that your new entry is beautifully displayed and that
the new Info document is accessible:
First, press the forward-slash key '/' (search)
Then, type: Exercalc (and press ENTER)
The highlight should now be on the menu entry.
Press ENTER (RET) key again, and verify that the main page of the Exercalc
documentation is displayed.
Then, exit the Info system: 'q' (quit).
If you want to remove the menu entry, use the command:
Next: Technical Support, Previous: Building from Source, Up: Top [Contents][Index]
Glossary of Terms User Interface Languages NcDialog Chart Widget
Several of the terms used in the Exercalc application are specific to physical activity disciplines. The following definitions were taken from public, non-copyrighed sources. Attribution is included when known.
The Metabolic Equivalent for Task (MET) is the ratio of your working metabolic rate relative to your resting metabolic rate.
One MET is approximately 3.5 milliliters of oxygen consumed per kilogram (kg) of body mass per minute while the person is sitting quietly.
1 MET = 1.0 minute x 1.0 kilograms x 3.5 milliliters of oxygen. Another way to calculate a MET is:
Source: <https://en.wikipedia.org/wiki/Metabolic_equivalent_of_task>
These calculations must be considered as an approximation because the person’s BMI (Body Mass Index), the ratio of body fat to lean body mass, has a significant influence on the actual value for an individual. Age, gender and general physical condition also affect METs valuation.
The METs value specified for a given activity is the ratio of energy expended for that activity as compared with the energy expended while the body is at rest, i.e. one MET, for the same period of time.
For example, walking at a moderate pace on level ground requires 3.3 times as much energy per kilogram as sitting on the couch. Thus, the ratio between walking and sitting is 3.3 METs.
One MET minute is energy expended in one minute while the body is at rest.
MET-minutes, then, is an expression of the energy expended during the exercise period. For example, walking at a pace of 5.6 km/hour (3.5 mph) requires approximately 3.3 times as much energy as sitting quietly.
Therefore one minute of walking equals 3.3 MET-minutes. Walking for 60 minutes would then be 3.3 x 60.0 = 198.0 MET-minutes.
Source: <https://www.omnicalculator.com/sports/met-minutes-per-week>
The standard calorie is too small a unit for calculations involving nutrition, so the “kilocalorie”, designated as 1.0 Calorie (upper-case ‘C’) or 1.0 kcal is used. One kilocalorie is equal to 1000 calories or 4184.0 joules.
One gram of body fat nominally contains 9.0 kilocalories of potential energy. Therefore, expending 9.0 kcal nominally consumes one gram of body fat. Note however that this is seldom true in practice because the human body uses the more-easily converted simple sugars in the blood stream (e.g. glucose) before beginning to convert actual fat to energy.
Source: <https://en.wikipedia.org/wiki/Calorie>
One mile equals 1.609344 kilometers:
5.0 miles x 1.609344 = 8.04672 kilometers
One kilometer equals 0.621371192 miles:
5.0 kilometers x 0.621371192 = 3.10685596 miles
One inch equals 2.54 centimeters:
5.0 inches x 2.54 = 12.7 centimeters
One centimeter equals 0.3937007874 inches:
5.0 centimeters x 0.3937007874 = 1.968503937 inches
One pound equals 0.45359237 kilograms:
5.0 pounds x 0.45359237 = 2.26796185 kilograms
One kilogram equals 2.204622622 pounds:
5.0 kilograms x 2.204622622 = 11.02311311 pounds
Where "3.5" is the mL of oxygen consumed per kilogram of body weight per minute; "BW" is body weight in kilograms; and "200" is a magic number.
Therefore the number of kCal burned during an exercise period is:
kCal = (METs x 3.5 x BW (kg) / 200) x min
<https://www.healthline.com/health/what-are-mets#calorie-connection>
Exercalc can support any reasonable number of user-interface languages.
The application is designed specifically to support multiple languages, and adding a new UI language requires only translation of the text and verification that the text will be displayed aesthetically within the dialog windows.
So long as the estabilshed pattern is followed, there is little chance
that adding a UI language will break the code.
The basic steps are to append a new element to the AppLang
enumerated type, and then search for all the references to the Exercalc
data member
'cfg.lang'
and then add the translated text to the associated array.
The author is happy to work with native speakers of other languages to translate the user interface titles, labels, descriptions and instructions into additional languages.
Exercalc is designed specifically to enable easy integration of new user interface languages. Some programming experience is certainly necessary, specifically experience with C++. Additionally, a general understanding of the author’s NcDialog API interface for console-based applications is helpful but not necessary.
The overarching consideration is to add the new UI language without breaking the existing code and without compromising display of the current interface languages. It should be unnecessary to change the actual code in any way. Simply add your translation to the data array.
The following example code shows the text for the Help sub-menu. This code defines the data displayed when this menu is opened.
On startup, the value from this array corresponding to the selection of user interface language will be used to initialize the application’s configuration flag, Exercalc::cfg.lang.
The following would reference the text for the menu:
hlpparmData[this->cfg.lang]
On startup, the value from this array corresponding to the selection of user interface language will be used to initialize the application’s configuration flag, Exercalc::cfg.rtl.
For technical reasons, a few methods encapsulate their own translated text, and/or positioning information, so the new language must be integrated for these individual methods.
The above list was definitive as of version 0.0.01; however, as the application develops, additional points of update may arise. In general, any method that references the Exercalc::cfg.lang data member may need to be updated when a new UI language is added.
It is not necessary to translate text that is used strictly for diagnostic and debugging messages. These messages are displayed only in English because they are used only during development.
If you are having trouble with some aspect of integrating your language into the application, please see Technical Support, and the author will be glad to assist in getting the new language fully integrated.
While Exercalc initially supports four (4) languages, these are all LTR (Left-To-Right) languages. The application has been extensively tested using simulated RTL data, so it is hoped that adding an RTL user-interface language will be straightforward.
Textbox controls can be used to edit both LTR (left-to-right) and RTL (right-to-left) language data. However, Exercalc and the underlying NcDialog API do not automatically determine the language being displayed, so it is left to the application designer to specify how the text will be displayed and edited.
Numeric fields, including date fields will be represented in Hindu-Arabic (Western Arabic) glyphs (0 through 9) which are inherently LTR text. Non-numeric text is displayed, and may be edited in either LTR or RTL format.
Please refer to the example dialog below with an LTR language (English), and an RTL language (Hebrew).
╔══════════╣ My Favorite Ice Cream Flavor ╠═══════════╗ ║ ║ ║ Please select your favorite ice cream flavor from ║ ║ the radio button group, below. If you enjoy toppings ║ ║ with your ice cream, enter the names of your favorite ║ ║ condiments in the text box. ║ ║ ║ ║ [ ] Chocolate ║ ║ [◆] Vanilla ║ ║ [ ] Strawberry ║ ║ [ ] Cherry ║ ║ [ ] Lemon Sherbet ║ ║ ║ ║ I like caramel sauce! ║ ║ Condiments ║ ║ Sale! Today Only. ║ ║ 0.25 Kilogram 0.40€ ║ ║ 0.50 Kilogram 0.75€ ║ ║ 1.00 Kilogram 1.50€ ║ ║ 2.00 Kilogram 2.80€ ║ ║ 5.00 Kilogram 7.00€ ║ ║ ║ ║ Close Dialog ║ ╚═══════════════════════════════════════════════════════╝
╔══════════════╣ ילע ביבחה הדילגה םעט ╠═══════════════╗ ║ ║ ║ ינצחל תצובקמ ךילע ףדעומה הדילגה םעט תא רחב אנא ║ ║ ,ךלש הדילגה םע תופסותמ הנהנ התא םא .הטמל ,הריחבה ║ ║ .טסקטה תביתב ךילע םיבוהאה םינילבתה תומש תא ןזה ║ ║ !םיעט טלחהב לבא ,רשכ אל ילוא הז ║ ║ ║ ║ דלוקוש [ ] ║ ║ לינו [◆] ║ ║ תות תדילג [ ] ║ ║ ןבדבוד [ ] ║ ║ ןומיל טברש [ ] ║ ║ ║ ║ !למרק בטור בהוא ינא ║ ║ םינילבתו םינילבת ║ ║ .םויה קר !הריכמ ║ ║ ₪1.60 םרגוליק 0.25 ║ ║ ₪3.00 םרגוליק 0.50 ║ ║ ₪6.00 םרגוליק 1.00 ║ ║ ₪11.20 םרגוליק 2.00 ║ ║ ₪28.00 םרגוליק 5.00 ║ ║ ║ ║ גולאידה תא רוגס ║ ╚═══════════════════════════════════════════════════════╝
Programmer’s Note: During development of support for RTL user interface languages, we defined the “DEBUG_MENU” and “DEBUG_RTL” conditional compile flags and the hidden '--rtl' command-line option which are used to fool the interface code into thinking that whatever the current interface language may be, it should be rendered as if it were RTL data. This has allowed us to exercise the internal direction flags and conditional expressions, to position messages and to test RTL editing of data fields without having to translate the entire interface into Hebrew. (That will be a much bigger challenge. !אנו נחודש )
To highlight just how much of a challenge it can be to support LTR, RTL and mixed LTR/RTL text in an application, please note that the info-reader utility was physically unable to display the mixed numeric and Hebrew text for the above screenshot in proper order. This is because the terminal emulation software insists on being “helpful”.
In this instance we gave up and inserted the letter 'z' into certain mixed LTR/RTL sequences to prevent the terminal from helpfully garbling the sequence. (For the HTML version of the document, it is possible to manually disable this kind of helpfulness.) Fortunately, when writing your own applications, you will have more direct control over the terminal environment.
Please refer to the NcDialog API documentation for a thorough discussion of the features and challenges of designing a user interface which supports both LTR and RTL languages.
** UNDER CONSTRUCTION **
The Chart class implements a configurable bar-chart widget under
the NcDialog API.
The Exercalc application includes a very early version of the Chart class implementation. Full documentation of the Chart class will be included in an upcoming release of the NcDialog API. Until then, the following notes will allow the application designer to play with the parameters of the Chart class.
Tools for development and testing of the Chart class are located in the Exercalc::DebugChartWidget() method in the EcConfig.cpp source module. This method is a temporary block of code, written in a Wild-West style, with very little emphasis on design, comments or error testing. This method will be cleaned up and moved into one of the NcDialog API test applications (probably Dialog4, Test #10).
The Chart class itself consists of two source files:
Chart.hpp - class definition
Chart.cpp - class implementation
While the code is written with the author’s usual OCD methodolgy, it is still very early in the development process, so errors, omissions and logical brain-farts are to be expected.
The Chart class is instantiated in the normal way using the constructor:
// Constructor:
Chart ( const chartDef& cdef, bool refresh = false );
// Instantiate the object:
Chart *cp = new Chart( cdef ) ;
The constructor for the Chart class takes its configuration data from an initialized instance of the chartDef class.
class chartDef
{
public:
NcDialog *dPtr; // pointer to dialog window in which to draw chart
// if null pointer, a new dialog will
short ulY; // upper left of chart area, Y
short ulX; // upper left of chart area, X
short rows; // number of rows in chart area
short cols; // number of columns in chart area
short yOff; // Y offset of grid within the display area
short xOff; // X offset of grid within the display area
short yFoot; // lines of freespace below grid
short barWidth; // bar width in "divisions" (1-8 divisions)
// (Note: fractional cell is always full cell width.)
short barSpace; // bar spacing 0 or 1 empty character cells between bars
chartType chType; // X/Y grid type (see above)
attr_t borderColor; // border color attribute
attr_t titleColor; // title color attribute
attr_t textColor; // basic text/background color
attr_t boldColor; // bold text color
attr_t gridColor; // color attribute for X/Y grid
attr_t barColor; // default color attribute for bars of bar chart
// (see also 'attrPtr' member)
attr_t negColor; // bar color for negative values (mixed positive and negative)
int32_t dataCount; // number of elements in 'dataPtr' (and 'attrPtr' if specified)
int32_t dataOffset; // index into 'dataPtr' array at which to begin display
const void* dataPtr; // pointer to array of data values to be charted
idataType dataType; // type of data pointed to by 'dataPtr' member
attr_t *attrPtr; // (optional) array of attributes, one for each bar
ncLineType borderStyle; // border style
ncLineType gridStyle; // grid-line style
const char* vaxisLabel; // vertical-axis label
const char* haxisLabel; // horizontal-axis label
const char* title; // (optional) title of the chart (displayed in top line of area)
const char* headText; // (optional) text to write above chart
const char* footText; // (optional) text to write below chart (legend, footnotes, etc.)
bool horizBars; // 'true' if horizontal bars, 'false' if vertical bars
bool barTips; // 'false'==display entire bar, 'true'==display tip of bar only
bool border; // if 'true' draw border around chart area
} ; // chartDef
Post instantiation modification methods are:
// Refresh the display. This makes any changes visible.
void refresh ( void );
// Clear the header-text area and write the specified text.
bool DrawHeaderText ( const char* txt, attr_t txtAttr,
bool refresh = false );
// Clear the footer-text area and write the specified text.
bool DrawFooterText ( const char* txt, attr_t txtAttr,
bool refresh = false );
// Add text to the footer area at the specified offset.
winPos DrawExtendedFooter ( const winPos& pos, const char* txt,
attr_t txtAttr, bool refresh = false );
// Draw a horizontal line across the display area.
bool DrawHorizontalLine ( short yOffset, ncLineType lType,
attr_t lAttr, bool refresh = false );
// Get position and size of header area.
bool GetHeaderPosition ( winPos& hdrPos, short& rows, short& cols );
// Get position and size of footer area.
bool GetFooterPosition ( winPos& ftrPos, short& rows, short& cols );
// Enable or disable audible alert in ShiftData() method.
bool AudibleShift ( bool enable );
// Interact with user to shift the data visible in the chart
// window forward and backward through the data array.
int32_t ShiftData ( wkeyCode& wkey, short sdCnt = ZERO,
ShiftDef *sdPtr = NULL );
// Set the display character for the datapoints
// of a Cartesian chart.
bool SetCartesianChar ( wchar_t cartChar ) ;
// Superimpose an additional dataset onto an existing
// Cartesian chart.
bool OverlayCartesianDataset ( const void* cartData, int32_t cartCount,
attr_t cartAttr,
idataType dType = idtDouble,
wchar_t cartChar = dblDiamond,
bool refresh = false );
// Returns a pointer to target dialog. (primarily for debugging)
NcDialog * GetDialog ( void );
// Returns the version number of the Chart class.
const char* GetVersion ( void );
Because this is an early version of the Chart class, all definitions and methods are subject to change.
Next: Copyright Notice, Previous: Tech Notes, Up: Top [Contents][Index]
Console applications have always been the most efficient and easily-implemented of computer programs. What they lacked was a friendly and visually-pleasing user interface.
With the NcDialog API, console applications can now be used and understood by experts and novice users alike.
FileMangler performs all basic file management tasks, as well as performing scheduled and ad-hoc file backup and synchronization activities.
FileMangler runs in a console window, and thus provides access to many system tools not available to a GUI application. FileMangler also provides full support for accessing the local Trashcan.
FileMangler is based on the NcDialog API, and thus will run in almost any GNU/Linux or UNIX terminal environment.
The HTML version of this document was formatted using ‘idpp’ and is displayed using the ‘infodoc-styles.css‘ definition file. Many more examples are available on the author’s website.
The gString class is lightweight, consisting of one C++ source
module and one header file. The gString class may be directly
integrated into an application, or may be built as a link library.
The gString class is also embedded within the NcDialog API library
(see above).
Conceptually, Taggit is an audio-file tag editor (metadata editor), and is album oriented rather than file oriented so that all audio files in an album may be edited simultaneously.
Taggit is not intended as a full-featured tag editor; for instance, Taggit does not access online databases of audio tag information. Taggit fully supports tag editing for audio formats: MP3, M4A, OGG/Vorbis and WMA.
The OGG/Vorbis I specification is supported for all text tags in '.ogg' and '.oga' audio files.
For MP3 audio files, all tag frames of the ID3v2.3 standard are supported, along with some features of ID3v2.4, such as support for UTF-8 text encoding which enables writing text tags in any language.
Taggit is implemented in four(4) user interface languages: Español (Spanish), Zhōngwén (中文) (Chinese, simplified), Tiếng Việt (Vietnamese) and English (U.S.). Additional user interface languages (both LTR and RTL) may be added with minimum effort.
‘srcprof’ can be used to profile source code for high-level languages such as C, C++ and Java, as well as various assembly languages and scripting languages such as Python, Perl and Ruby. For a complete list of currently-supported source languages, please see the Source Profiler documentation.
’srcprof’ can be used both as a productivity-measurement tool and as a tool for testing source code quality based on an evaluation of its ‘maintainability’.
Source Profiler is a console-based utility, which runs as either a pure, command-line utility, OR as a dialog application based on the NcDialog API.
WaylandCB is a simple C++ class definition which provides console applications with seemless access to the system clipboard.
‘dvdrep’ can be used to rescue data from any non-encrypted DVD video source disc that is formatted using the Universal Disc Format (UDF) filesystem (as all commercially produced DVD movies are).
‘dvdrep’ takes a layered approach to the analysis of the source disc. A detailed log file is maintained for each step of the process in case manual intervention is needed at a later step.
DVD Repair is based on the NcDialog API, and thus will run in almost any GNU/Linux or UNIX terminal environment.
Next: Index, Previous: Technical Support, Up: Top [Contents][Index]
| • GNU General Public License | ||
| • GNU Free Documentation License |
Next: GNU Free Documentation License, Up: Copyright Notice [Contents][Index]
The GNU General Public License is a free, copyleft license for software and other kinds of works.
The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change all versions of a program—to make sure it remains free software for all its users. We, the Free Software Foundation, use the GNU General Public License for most of our software; it applies also to any other work released this way by its authors. You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you these rights or asking you to surrender the rights. Therefore, you have certain responsibilities if you distribute copies of the software, or if you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must pass on to the recipients the same freedoms that you received. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
Developers that use the GNU GPL protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License giving you legal permission to copy, distribute and/or modify it.
For the developers’ and authors’ protection, the GPL clearly explains that there is no warranty for this free software. For both users’ and authors’ sake, the GPL requires that modified versions be marked as changed, so that their problems will not be attributed erroneously to authors of previous versions.
Some devices are designed to deny users access to install or run modified versions of the software inside them, although the manufacturer can do so. This is fundamentally incompatible with the aim of protecting users’ freedom to change the software. The systematic pattern of such abuse occurs in the area of products for individuals to use, which is precisely where it is most unacceptable. Therefore, we have designed this version of the GPL to prohibit the practice for those products. If such problems arise substantially in other domains, we stand ready to extend this provision to those domains in future versions of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents. States should not allow patents to restrict development and use of software on general-purpose computers, but in those that do, we wish to avoid the special danger that patents applied to a free program could make it effectively proprietary. To prevent this, the GPL assures that patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and modification follow.
“This License” refers to version 3 of the GNU General Public License.
“Copyright” also means copyright-like laws that apply to other kinds of works, such as semiconductor masks.
“The Program” refers to any copyrightable work licensed under this License. Each licensee is addressed as “you”. “Licensees” and “recipients” may be individuals or organizations.
To “modify” a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a “modified version” of the earlier work or a work “based on” the earlier work.
A “covered work” means either the unmodified Program or a work based on the Program.
To “propagate” a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well.
To “convey” a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays “Appropriate Legal Notices” to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion.
The “source code” for a work means the preferred form of the work for making modifications to it. “Object code” means any non-source form of a work.
A “Standard Interface” means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language.
The “System Libraries” of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A “Major Component”, in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it.
The “Corresponding Source” for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work’s System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those subprograms and other parts of the work.
The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source.
The Corresponding Source for a work in source code form is that same work.
All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary.
No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures.
When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work’s users, your or third parties’ legal rights to forbid circumvention of technological measures.
You may convey verbatim copies of the Program’s source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee.
You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions:
A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an “aggregate” if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation’s users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate.
You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways:
A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work.
A “User Product” is either (1) a “consumer product”, which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, “normally used” refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product.
“Installation Information” for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made.
If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM).
The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying.
“Additional permissions” are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms:
All other non-permissive additional terms are considered “further restrictions” within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way.
You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11).
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10.
You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so.
Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License.
An “entity transaction” is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party’s predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it.
A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor’s “contributor version”.
A contributor’s “essential patent claims” are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, “control” includes the right to grant patent sublicenses in a manner consistent with the requirements of this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor’s essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version.
In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party.
If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient’s use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it.
A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law.
If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program.
Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination as such.
The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU General Public License “or any later version” applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU General Public License, you may choose any version ever published by the Free Software Foundation.
If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the “copyright” line and a pointer to where the full notice is found.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:
The hypothetical commands ‘show w’ and ‘show c’ should show the appropriate parts of the General Public License. Of course, your program’s commands might be different; for a GUI interface, you would use an “about box”.
You should also get your employer (if you work as a programmer) or school, if any, to sign a “copyright disclaimer” for the program, if necessary. For more information on this, and how to apply and follow the GNU GPL, see https://www.gnu.org/licenses/.
The GNU General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Lesser General Public License instead of this License. But first, please read https://www.gnu.org/licenses/why-not-lgpl.html.
Previous: GNU General Public License, Up: Copyright Notice [Contents][Index]
The purpose of this License is to make a manual, textbook, or other functional and useful document free in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.
This License is a kind of “copyleft”, which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.
We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.
This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The “Document”, below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as “you”. You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.
A “Modified Version” of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.
A “Secondary Section” is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.
The “Invariant Sections” are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.
The “Cover Texts” are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.
A “Transparent” copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not “Transparent” is called “Opaque”.
Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.
The “Title Page” means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, “Title Page” means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.
The “publisher” means any person or entity that distributes copies of the Document to the public.
A section “Entitled XYZ” means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as “Acknowledgements”, “Dedications”, “Endorsements”, or “History”.) To “Preserve the Title” of such a section when you modify the Document means that it remains a section “Entitled XYZ” according to this definition.
The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.
You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.
You may also lend copies, under the same conditions stated above, and you may publicly display copies.
If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.
If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.
If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.
It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.
You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:
If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.
You may add a section Entitled “Endorsements”, provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.
You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.
The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.
You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.
The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.
In the combination, you must combine any sections Entitled “History” in the various original documents, forming one section Entitled “History”; likewise combine any sections Entitled “Acknowledgements”, and any sections Entitled “Dedications”. You must delete all sections Entitled “Endorsements.”
You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.
You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.
A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an “aggregate” if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.
If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.
Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.
If a section in the Document is Entitled “Acknowledgements”, “Dedications”, or “History”, the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.
You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.
However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.
The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See https://www.gnu.org/licenses/.
Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License “or any later version” applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.
“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A “Massive Multiauthor Collaboration” (or “MMC”) contained in the site means any set of copyrightable works thus published on the MMC site.
“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.
“Incorporate” means to publish or republish a Document, in whole or in part, as part of another Document.
An MMC is “eligible for relicensing” if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.
The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.
To use this License in a document you have written, include a copy of the License in the document and put the following copyright and license notices just after the title page:
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
If you have Invariant Sections without Cover Texts, or some other combination of the three, merge those two alternatives to suit the situation.
If your document contains nontrivial examples of program code, we recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.
Previous: Copyright Notice, Up: Top [Contents][Index]
| Jump to: | 0
1
A B C D E F G H I K L M N O P R S T U V W |
|---|
| Jump to: | 0
1
A B C D E F G H I K L M N O P R S T U V W |
|---|