Next: Introduction, Up: (top) [Contents][Index]
Copyright © 1998-2015 Mahlon R. Smith, The Software Samurai
This manual describes version 0.0.18 of ’srcprof’.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
’srcprof’ analyzes source code modules for clarity and readability, which are referred to in this document as ’maintainability’.
| • Introduction: | What is Source Profiler? | |
| • Operational Overview: | ’Interactive Mode’ and ’Text Mode’ | |
| • Invoking: | Command-line arguments and options | |
| • Source-module Types: | List of supported source code types | |
| • Maintainability Analysis: | What we do and how we do it | |
| • Error Messages: | Our fingers sometimes slip | |
| • Building from Source: | Compile the application | |
| • Technical Support: | Make suggestions, report problems. | |
| • Copyright Notice: | Boring, but useful. | |
| • Index: |
Next: Operational Overview, Previous: Top, Up: (top) [Contents][Index]
Source Profiler (srcprof) is a source code analysis tool for determining the ’maintainability’ of source code modules.
’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, (see Source-module Types).
’srcprof’ operates by counting the number of source code lines and comments in program source modules and performing simple statistical analysis on the data gathered (see Maintainability Analysis).
’srcprof’ can be used as a measurement tool for showing the bean-counters
that your software project is making progress, as in:
"I wrote 250 lines of well-documented code today."
It is also useful as a test of code quality based on an evaluation of
its ’maintainability’.
Source code is written for people to read, and is not just an intermediate step on the way to executable applications.
The largest cost in any software project, in terms of programmers’ time and other project resources is in the maintenance of the code. Well-presented code is much easier to understand and to maintain, and this presentation consists of an uncrowded and consistent layout which includes the use of abundant and meaningful comments.
Next: Invoking, Previous: Introduction, Up: Top [Contents][Index]
Source Profiler has two operating modes: Interactive Mode, and Text-only Mode. Both operating modes run within a terminal window, and each operating mode has its uses. Text-only Mode may be more attractive for those who are accustomed to Linux/UNIX console utilities, while Interactive Mode offers greater flexibility and convenience, as well as a more gentle learning curve for those who are new to the Linux/UNIX world.
Important: Source Profiler is fully UTF-8 aware and supports analysis of all UTF-8-encoded text files.
| • Interactive Mode: | NcDialog (ncurses) user interface | |
| • Text Mode: | Text-only output to the console |
Next: Text Mode, Up: Operational Overview [Contents][Index]
Interactive Mode is the default operating mode. That is, when you invoke ’srcprof’ without arguments, the application will open in Interactive Mode.
Please note that if srcprof was built using the text-only
build option, then Interactive Mode will not be available.
All command-line options (see Invoking.) are available when invoking Interactive Mode, except of course the ’-t’ (Text Mode) option. Certain additional features are available only in Interactive Mode.
Important: Because Interactive Mode is a windowed interface, the terminal window must be set to at least the minimum window size in order for the dialog to open.
Minimum window size: 25 lines by 80 columns
When you invoke ’srcprof’ in Interactive Mode, but without specifying any source code filenames, the application will open the dialog with a file-selection window through which you can interactively select the source code modules to be analyzed.
When you invoke ’srcprof’ in Interactive Mode, and you do specify source code filenames on the command line, then those source code modules will be immediately analyzed and the results will be displayed in the dialog rather than displaying the file-selection window. Please see Invoking for more information.
Interactive Mode is built around the NcDialog API which allows console (text-based) applications to present a windowed interface to the user. Please see Tech Notes, section for more information.
We regret that the screen captures in the info-format version of the online documentation cannot show the dialog’s colors; however, the screen captures in the HTML-format documentation more accurately display the dialog’s features.
The following is an example of Interactive Mode display of analytical data. Source code modules for analysis have been specified on the command line, and the data sorting option specified is by filename (case-insensitive).
[FileMangler]$ srcprof -s=n *.hpp
Please see Text Mode for a description of the individual data columns and summary analysis.
This section shows an example of Interactive Mode file selection.
Here are some things to keep in mind when selecting files for analysis:
[FileMangler]$ srcprof
When the file-selection window is active, you may select files by scrolling
to the desired filename and pressing either the SPACE key or the ENTER key.
a) The filename will be underlined to indicate that it is ’selected’.
b) The highlight will advance to the next filename (if any).
c) The ’Files Selected’ and ’Total’ count will be incremented.
To de-select a ’selected’ (underlined) filename, move the highlight to
that filename and again press SPACE or ENTER.
a) The underline will be removed from the filename.
b) The highlight will advance to the next filename (if any).
c) The ’Files Selected’ and ’Total’ count will be decremented.
Press the TAB key when selection is complete. All selected files will then be analyzed, and the analytical data will be displayed in the scrolling window (see example above).
If no files are selected for analysis, the message "NO SOURCES FILES SPECIFIED" will be displayed.
The file-selection list includes both the ’parent’ (higher-level) directory and any subdirectory names below the current working directory (CWD). These directory names are grouped at the top of the list.
You may move freely through the directory tree searching for source code files. To change the CWD, highlight the desired directory name and press the ENTER key.
The function of the scrolling-window dialog control has been described above. The remaining user-accessible controls are ’pushbutton’ controls. These controls are activated by pressing the TAB or SHIFT+TAB keys to move the input focus to the desired pushbutton (pushbutton color will change from Grey to Red), then press the ENTER key to activate the control.
You may at any time save the displayed analytical data to a file located in the directory from which ’srcprof’ was invoked. The format of the saved data may be either plain text or HTML. The default name for the log file is ’srcprof_log.txt’ (or ’srcprof_log.html’), but any filename may be specified.
Note: The 'SAVE' pushbutton will not be available if there are no statistical data displayed.
Select the output format:
You may also choose one of the following options:
To select one of the options, use the TAB or SHIFT+TAB keys to highlight the desired radio button, then press the SPACE or ENTER key.
Use the ’SAVE’ pushbutton to save the data and return to the main dialog.
OR
Use the ’CANCEL’ pushbutton to return to the main dialog without saving.
Each save is preceeded by a header indicating the base directory where the files are located and a date/timestamp indicating when the data were saved.
Example:
# Source Profiler Analytical Data
# for directory: 'FileMangler'
# Created: 2015-07-02 @ 17:05:54
# -------------------------------
The analytical data itself, with column headings and summary, are saved in the same layout used to display the data on the screen (see above), except that plain-text log file data are not color coded.
If, during the session, you have saved analytical data to a file, then when exiting from the application a message will be written to the console reminding you about the saved data.
Example: Source Profiler v:0.0.18 (c)1998-2015 The Software Samurai ------------------------------------------------------------------------------ ** Statistical data saved to file: 'srcprof_log.txt' **
To change the sort option for the currently-displayed analytical data, TAB to the ’SORT’ pushbutton and then press ENTER.
A dialog will open which displays the available options. The current sort option is indicated by the ’selected’ (contains a bullet character) radio button.
To select a new sort option, use the TAB or SHIFT+TAB keys to highlight the desired radio button, then press the SPACE or ENTER key. The desired option may also be selected via ’hotkey’ as indicated by the underlined character in the description of the option.
Use the ’OK’ pushbutton to return to the main dialog with the new
sort option, OR
Use the ’CANCEL’ pushbutton to return without selecting a new sort option.
Any errors in command-line options, source code module access errors or other processing errors will be reported on exit from the application. Please see Error Messages for more information.
Previous: Interactive Mode, Up: Operational Overview [Contents][Index]
Text-only Mode is a standard console interface.
This mode is useful for a quick check on just a few files, or if you want
to pipe, filter or redirect the application’s output.
To display without line-wrap, the terminal window should be set to a minumum of 25 lines by 80 columns.
All command-line options (See Invoking.) are available when invoking Text Mode, except of course the '-i' (Interactive Mode) option. Certain additional features are available only in Interactive Mode.
Results of the source code analysis are displayed either in Interactive Mode where the results are displayed in the scrolling control of a dialog window, or in Text Mode where the results are written directly to the terminal. In both cases, the format of the output is as shown in the following example of Text Mode output.
Data sorting in this example is by filename extension, which is the default sort (see 's' option).
Color coding of the items in the list is determined by the ’Maintainability Threshold’ settings (see 'm' option).
[FileMangler]$ srcprof -t FileDlg.cpp FileDlgRename.cpp gString.[ch]pp
The data are arranged in columns. From left-to-right: .....................................................
The first two rows of output are the Text Mode application header. The next two rows of output are the column headings. One row is required for each source code module analyzed. The last two rows of output are the totals in each category for all listed files, including the AVERAGE maintainability index.
Any errors in command-line options, source code module access errors or other processing errors will be reported on exit from the application. Please see Error Messages for more information.
Next: Source-module Types, Previous: Operational Overview, Up: Top [Contents][Index]
srcprof [OPTIONS] [FILENAMES]
Options and filenames may be specified in any order.
Options without parameters may be combined into a single token.
Any reasonable number (hundreds) of source filenames may be specified using any combination of direct specification, and the '-l', '-d' or '-a' options.
Examples:
srcprof GooeyCode.cpp HeadCode.hpp GoldCode.asm
srcprof -a ../cTrash/cTrashFile.hpp
srcprof -tcd=../DvdRep/xprtLayer GlobalDef.hpp -w=sp_log.txt
Simple pattern matching may also be used to select the files:
srcprof *.cpp
srcprof FileDlg*.[ch]pp
srcprof Acme_*Widget.c libdir/*lib.h
Interactive Mode is implemented as a dialog window and is the default operating mode.
Because this is the default operating mode, '-i' is optional.
Note: If the application was built in Text-only Mode, then this option is accepted, but ignored.
(See Interactive Mode, for more information).
Text Mode operates as a simple, console (text-only) utility which sends all display data to ’stdout’ (standard output).
Note: If the application was built in Text-only Mode, then this option is accepted, but ignored.
(See Text Mode, for more information).
The current working directory will be scanned, and all ’regular’ files with supported filename extensions will be analyzed.
(See Source-module Types, for more information).
Specify the name of a plain text file containing a list of source code files to be analyzed.
Examples:
srcprof -l=sflist.txt
srcprof -l=~/sam/Software/cTrash/sflist.txt
Any reasonable number of source filenames may be specified, one filename or path/filename per line.
Lines which begin with with the hash character (’#’) in the first column will be interpreted as comments and will be ignored. Blank lines are also ignored.
The specified directory will be scanned, and all ’regular’ files with supported filename extensions will be analyzed.
(See Source-module Types, for more information).
Examples:
srcprof -d=TestData
srcprof -d=~/sam/Software/FileMangler
Sort the output according to the specified sub-option:
[ e | n | m | s ]
-s=e
Sort alphabetically by filename extension (low-to-high), and within
each group of files with the same extension, sort by filename.
(This is the default sort option.)
Note that alphabetical sorts are case-insensitive according to the rules of the locale used by your system.
-s=n
Sort alphabetically by filename (low-to-high).
-s=m
Sort by maintainability index (low-to-high).
Please see Maintainability Analysis for a description of ’maintainability’.
-s=s
Sort by the number of source code lines in the file (low-to-high).
For Text Mode only: Disable embedded ANSI color escape sequences in the output.
By default, ANSI escape sequences are used by the Text Mode interface to indicate the ’maintainability’ level of each source file. While this is a useful feature for display in the terminal window, if you redirect ’stdout’ to a file or use the output of ’srcprof’ as input to another utility, you may get unexpected results.
For this reason, if you are redirecting the ’stdout’ stream, you may want to use the '-c' option to disable ANSI color.
Example: srcprof -tac >srcprof_log
The ’cat’ utility will correctly interpret the ANSI color codes; however, ’more’, ’less’ and other text utilities as well as most text editors will interpret the ANSI escape sequences as plain text.
If you want to write color-coded output to a file, it is recommended that the '-w=LOGFILE' option be used to write the output as an HTML document.
Note: The '-c' option has no effect on the Interactive Mode interface.
For Text Mode only: On exit, write a copy of the analytical data to a log file.
Specify the name (or path/filename) of the target log file. If a path is not specifed, then the log file will be written to the directory from which the application was invoked, i.e. the current working directory.
Log data may be written either as a plain-text file or as an HTML-format file. The filename extension determines the file format.
Note: For Interactive Mode, writing the data to a log file is handled through an interactive dialog.
Specify alternate thresholds for code evaluation. Four(4), comma-delimited arguments (no spaces) are required.
Example:
srcprof -m=40,25,55,45
The values are interpreted as percentages in the (range 0-100%):
'Good Maintainability for high-level languages' (default: 40%) 'Fair Maintainability for high-level languages' (default: 25%) 'Good Maintainability for assembly languages' (default: 55%) 'Fair Maintainability for assembly languages' (default: 45%)
In practical terms, these threshold values determine the color coding for display of the analytical data.
In general, these threshold values apply only to high-level languages and to assembler. While scripting languages and mark-up languages also benefit greatly from consistent formatting, meaningful comments and adequate whitespace, they require fewer comments than "real" programming languages. By default, the maintainability thresholds for scripting languages and markup are:
'Good Maintainability' : 25% 'Fair Maintainability' : 10%
We recognize, however, that many people are quite passionate about their chosen scripting language, so we offer an extension to the -m option to support Perl-divers, Python-wranglers and other script hackers:
An optional fifth (5th) and sixth (6th) parameters may be supplied which specify the maintainability thresholds for scripts and markup languages.
Example:
srcprof -m=40,25,55,45,25,10
Both paramers must be specified, and again, the values are interpreted as percentages in the (range 0-100%):
Command-line Help. Display a brief summary of command-line usage and options. (overrides everything else on command line except '--version')
Display srcprof’s version number and copyright information. (overrides everything else on command line)
then ’srcprof’ will exit with a warning indicating which filename(s) caused the error.
For an explanation of what constitutes a ’regular file’, please see Tech Notes.
Next: Maintainability Analysis, Previous: Invoking, Up: Top [Contents][Index]
The filename extension determines the method used to scan the source module. The following filename extensions are recognized. (Recognition of filename extensions is not case-sensitive.)
.c = C language source files",
.h = C header files
.cpp = C++ language source files
.hpp = C++ header files
.java = Java language source files
.js = Javascript files
.as = Flash ActionScript files
.m, .mm, .h = Objective-C source files
.cs = C# source files
.asm = Assembly language source files (Intel, Motorola, etc.)
.inc = Assembly language header files
.m51 = 8051-family assembly language files
.s07 = 68HC11-family assembly language files
.s33 = 68HC12-family assembly language files
.sh = Shell script files
(see note below for filenames with no extension)
.py, .pyw = Python script files
.pl, .pm, .t = Perl script files
.vb, .vbs = Visual Basic source files and VBScript files
.texi, .texinfo = Texinfo documentation mark-up source files
.html, htm = HTML mark-up
.css = Cascading Style Sheet files
If your source files do not use these extensions, but you believe that the syntax for comments is similiar to one of the above, simply rename your source file and give it a try.
For high-level languages, a comment sequence enclosed within a literal text string will be properly ignored, but for scripting languages, literal strings are not parsed.
However in general, if the GNU compiler or a script interpreter (e.g. ’bash’) can parse it, then ’srcprof’ can also parse it.
The reason this works is because the first line of a shell script starts with a shebang: '#!' sequence, followed by the path of the shell program. For example:
#!/bin/bash
For specified source files which have no filename extension, ’srcprof’
reads the first line of the file. IF the shebang sequence is found in
the first column, AND IF the path which follows the shebang
indicates:
"bash", "sh", "csh" or "tcsh"
then the file will be scanned as a shell script.
Other files with no filename extension are reported as invalid source-file types.
#{ curley-brace pair
. . .
}
#[ square-bracket pair
. . .
]
#( parentheses pair
. . .
)
#< angle-bracket pair
. . .
>
#« double-angle pair
. . .
»
We tend toward the philosophical camp that sees Pod sequences as equivalent to a markup language and therefore, with two(2) exceptions, we interpret all Pod sequences as code. The exceptions are:
=begin comment . . . =end comment =begin comment . . . =cut
We have made a design decision that we will also scan for CSS (i.e. 'C'-style) comments, but ONLY within the <head> . . . </head> block.
Beyond the </head> tag, however, all 'C'-style comments are ignored because it is not practical to determine whether they are CSS comments or HTML body text which is discussing 'C' code.
For instance, to determine which of the following are CSS comments and which are body text, we would need to fully parse each HTML tag, which is beyond the scope of this simple project.
<span style="font-weight:bold; /* Code examples are in Bold */
font-family:monospace; /* Typewriter Text */
white-space:pre; /* Preformatted */">
/* Compare the objects */
if ( obj1 == obj2 )
{
/* do stuff */
}
else
{
/* do stuff */
}</span>
In addition, PHP (and PHP comments) may be embedded within HTML markup; however, ’srcprof’ do not scan for embedded PHP.
Finally, HTML is an organic language which has developed according to the needs of the moment. For this reason, comments in HTML are not always comments. As an example, "conditional comments" were developed to support the train wreck known as Internet Explorer(tm). ’srcprof’ ingnores such garbage based on the fact that anyone who would write IE-specific code probably doesn’t care whether the answer is correct anyway.
Future support for the following source file types is planned:
PHP .php .phtml .php3 .php4 .php5 .phps Ruby .rb .rbw SQL .sql
Next: Error Messages, Previous: Source-module Types, Up: Top [Contents][Index]
"Programs must be written for people to read,
and only incidentally for machines to execute."
— Harold Abelson and Gerald Jay Sussman (MIT)
In the days when dinosaurs roamed the earth, UNIX/C programmers often used comment strippers as a form of job security — if no one else knew what the code was doing, then you became indispensible and therefore couldn’t be fired. In today’s world, however, the use of a comment stripper is a criminal offense, my friends — and maintainability is rightly considered as more important than mere functionality.
Yes, self-documenting code is a given. If you are writing code that is not self-documenting, do the world a favor and step away from your keyboard. But the code itself can only explain what you are doing. Comments explain why you are doing it — and your reasons for doing it this way and not another way. Perhaps most importantly, writing comments helps you to think by forcing you to explain your own code to yourself, which is the best way I know of finding (or avoiding) logical errors. And now, back to our regularly-scheduled programming....
Maintainability analysis of source code by ’srcprof’ is quite simple.
Each line in the source module is categorized as one of the following:
1) a line which contains only source code
2) a line which contains both source code and comments
3) a line which contains only comments
4) a line which contains only whitespace (spaces, tabs, or no data)
’srcprof’ determines the maintainability of the code based on the ratio of comments and whitespace to the total number of lines in the source module. Please see Invoking, ’-m’ option for adjusting maintainability thresholds.
Guidelines for C/C++, Java and other high-level languages
Code written in a high-level language should contain at least
40% comments and whitespace, and never less than 25% comments.
Guidelines for Assembly Languages
Code written in assembly languages should contain comments
on no less than 50% of the source module lines.
Guidelines for Scripting and Markup Languages
The need for comments in scripting and markup languages varies
widely; however, Perl, Python, Ruby, bash and other scripts
benefit from having at least 10-25% comments and whitespace.
HTML/CSS and similar markup languages should contain
approximately 15-25% comments and whitespace.
The data gathered by ’srcprof’ for each source code module specified:
The ’maintainability index’ is expressed as a percentage:
((totalComments + whitespace) / totalSourceLines) * 100.0
In addition to the data gathered for each module, an accumulated total for
each category is also generated, as well as an average maintanability index
for all files analyzed.
Please see Text Mode for an example of how the data are presented.
Technical Notes:
Next: Building from Source, Previous: Maintainability Analysis, Up: Top [Contents][Index]
Error messages in ’srcprof’ are as informative as possible; however, to avoid misunderstandings, the following is a brief discussion of each error message and the situations under which it is displayed.
There are three general categories for errors which may be reported. Within each category, one or more specific errors may occur.
The indicated source code file either does not exist on the specified path OR it is a ’special’ file OR you do not have read access to the file.
The indicated file has a filename extension, for example ’foo.jpg’, which is not recognized as a supported source code module type.
The indicated file which was expected to contain a list of source code filenames, either a file specified on the command line using the ’-l’ option OR a temporary list file generated by ’srcprof’, was not found (unlikely), OR you do not have read access to the file.
The indicated file which was expected to contain a list of source code filenames either contains no valid source code filenames OR there are formatting errors in the file which make the file unreadable by ’srcprof’.
The indicated directory name or a path to that directory was specified using the ’-d’ option, but the directory was not found.
The indicated directory specified using the ’-d’ option either contains no recognized source code files OR you do not have read access for the directory’s contents.
The indicated option (represented here by ’?’) is not a valid ’srcprof’ command-line option.
The ’-l’ (List) option was specified, but the name of the list file was not specified.
The ’-d’ (Directory) option was specified, but the name of the directory to be scanned was not specified.
The ’-s’ (Sort) option was specified, but the required sub-option:
’e’(extension), ’n’(name), ’m’(maintainability) or
’s’(source lines) is missing or invalid.
The ’-w’ option was specified, but the name of the output log file was not specified.
The ’-m’ (Maintainability threshold) option was specified, but there are too few sub-options OR the value of one or more sub-options is outside the allowed range.
Interactive Mode uses the NcDialog-class which is based on the ncurses C function library. This library is installed by default on nearly every Linux/UNIX system, and it is required in order to run ’srcprof’ in Interactive Mode. (The Text Mode interface does not require the ncurses library.)
The ’locale’ is the scheme by which data read and written on your system are adjusted (localized) for your country, region or language.
’UTF-8’ character encoding is a byte-oriented code used to represent the characters of all known languages, countries and regions. UTF-8 is the native character encoding under Linux, so you SHOULD have no trouble with this; however, exceptions in system configuration will sometimes occur. If this happens, check the locales supported on your system by typing: ’locale -a’ at the command prompt. Check your terminal’s environment by typing: ’env | less’ at the command prompt. The environment variable of interest is: ’LANG’, although other variables such as ’LC_ALL’ or ’LC_CTYPE’ may also be present.
Verify that the encoding specified supports UTF-8, and if it does not, set the environment variable to an appropriate encoding. EXAMPLE: LANG=en_us.UTF-8 If your system does not support UTF-8 encoding, Interactive Mode will still function, but only ASCII text will be reliably displayed. For more information on locales, type ’info setlocale’, or see the system header files: ’locale’ and ’langinfo.h’
Because Interactive Mode is a windowed interface, the terminal window must be set to at least the minimum size to open the dialog. For optimal viewing, Text Mode should also be run in a terminal of at least this minimum size; however, Text Mode simply wraps lines that are too long to the following line, which is ugly, of course, but is not critical.
During execution, ’srcprof’ creates temporary files. These temporary files are created in the system’s local temp-file directory. In order to create these temporary files, you, the user, must have read/write access to the target directory.
See the documentation for the system’s C-language function 'tmpnam_r' for additional details on creating temporary files.
See Invoking, section gives a complete list of command-line options.
’srcprof’ will display messages for as many detected errors as possible. The following is an example of an error report for seven (7) detected errors.
[sam]$ srcprof -d=quack like Donald Duck install Makefile -Z
Source Profiler v:0.0.18 (c)1998-2015 The Software Samurai ------------------------------------------------------------------------------ Specified source directory 'quack' was not found. Source file 'like' not found, not a regular file or no read access. Source file 'Donald' not found, not a regular file or no read access. Source file 'Duck' not found, not a regular file or no read access. Source file 'install' not found, not a regular file or no read access. 'Makefile' has an unsupported filename extension. '-Z' is an unrecognized option. Type: srcprof --help
Next: Technical Support, Previous: Error Messages, Up: Top [Contents][Index]
SourceProfiler and the NcDialog API library are both written in C++ and are built with the GNU C++ compiler and linker.
SourceProfiler is compiled using the GNU/G++ compiler which is invoked through the ’gmake’ (’make’) utility. The compile and linking instructions are contained in the file named ’Makefile’. See below for example invocation of the compile sequence.
SourceProfiler is a dual mode application. In Text-only Mode, srcprof is a simple, console application outputting to 'wcout'; while in Interactive Mode, srcprof uses the NcDialog API to allow interactive selection of source files and options to save the output to either a plain-text file or an HTML document file.
SourceProfiler may be built with both Text Mode and Interactive Mode interfaces, OR as a Text-only application. This is controlled by the COMM_LINE_ONLY, conditional compile switch located at the top of the SrcProf.hpp source module.
#define COMM_LINE_ONLY (0)
Build with both Text Mode and Interactive Mode.
(link with ncursesw and NcDialog API libraries)
gmake clean
gmake
#define COMM_LINE_ONLY (1)
Build with Text Mode only (as a pure, command-line utility).
gmake -f Make_textonly clean
gmake -f Make_textonly
To test the Interactive-mode build, invoke the application twice, once in Text Mode and once in Interactive Mode.
./srcprof -t -a (Text Mode, All files in current directory) ./srcprof -i -a (Interactive Mode, All files in current directory)
If the application opens and provides results in both operating modes, all is well. If some error is detected, then it is likely that one or more necessary shared resources is not available. Use the 'ldd' command to list the necessary dynamic-load libraries.
Something like the following should be displayed. Be sure that all listed libraries are available.
[SourceProfiler]$ ldd srcprof linux-vdso.so.1 => (0x00007ffdd75f7000) libncursesw.so.5 => /lib64/libncursesw.so.5 (0x0000003a1a400000) libtinfo.so.5 => /lib64/libtinfo.so.5 (0x0000003a2fc00000) libstdc++.so.6 => /lib64/libstdc++.so.6 (0x0000003a28000000) libm.so.6 => /lib64/libm.so.6 (0x0000003a1a000000) libgcc_s.so.1 => /lib64/libgcc_s.so.1 (0x0000003a1bc00000) libc.so.6 => /lib64/libc.so.6 (0x0000003a19000000) libdl.so.2 => /lib64/libdl.so.2 (0x0000003a19400000) /lib64/ld-linux-x86-64.so.2 (0x0000003a18c00000)
To test the Text-mode-only build, invoke the application:
./srcprof -a (Analyze all files in current directory)
For the srcprof application to be visible throughout your system, you will need to copy the ’srcprof’ binary file to a directory on your execution path.
To see your execution path, type: echo $PATH.
[SourceProfiler]$ echo $PATH /usr/local/bin:/usr/bin:/bin:/usr/local/sbin: /usr/sbin:/home/sam/.local/bin:/home/sam/bin
The directories searched for binaries 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.
EXAMPLE: cp --preserve srcprof /home/sam/bin/.
Documentation for ’srcprof’ is provided in both Texinfo (info) format and HTML format.
To view the HTML-format documentation, navigate to:
SourceProfiler/Texinfo
then load the 'srcprof.html' document into your favorite browser.
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:
SourceProfiler/Texinfo
then view the documentation using the following command:
info -f srcprof.info
Follow these steps to install the SourceProfiler documentation into the ’info’ database.
Example: cd ~/MySoftware/SourceProfiler/Texinfo (substitute your actual installation path)
/usr/local/share/info/dir
For global system users, this is typically:
/usr/share/info/dir
Example: sudo cp --preserve=timestamps srcprof.info /usr/local/share/info/. (substitute the actual path to the directory containing the 'dir' file) Enter your password when prompted.
cd /usr/local/share/info
ls -l srcprof.info
sudo install-info
--dir-file=dir --info-file=srcprof.info
--name=’SourceProfiler’ --debug
Note that this is a single command, typed all on one line
even though it may look strange as printed here.
Enter your password when prompted.
Type the following command: info
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: SourceProfiler (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
SourceProfiler documentation is displayed.
Then, exit the Info system: ’q’ (quit).
If you want to remove the menu entry, use the command:
sudo install-info
--dir-file=dir --info-file=srcprof.info
--name=’SourceProfiler’ --remove --debug
Again, this is a single command, typed all on one line.
Enter your password when prompted.
Next: Copyright Notice, Previous: Building from Source, Up: Top [Contents][Index]
Please Note: All trademarks and service marks mentioned in this document are the entirely-too-proprietary property of their respective owners, and this author makes no representation of affiliation with or ownership of any of the damned things.
SourceProfiler (srcprof) binary, source code and associated Texinfo
documentation were written and are maintained by:
Mahlon R. Smith,
The Software Samurai
Beijing University of Technology
on the web at: www.SoftwareSam.us
For bugs, suggestions, periodic updates, or possible praise,
please post a message to the author via website.
The author wishes to thank everyone for their intelligent, kind
and thoughtful responses. (ranters I can live without)
Source Profiler (srcprof) began life in 1998 as an MS-DOS(tm) utility, ’srcline’, which was written to help answer management’s persistant and annoying question, "what have you accomplished today?" Because management types simply cannot maintain mental focus for any technical explanation lasting more than 15 seconds, I saw this little utility as a way to quantify my daily progress. At the time, I was writing in assembler for embedded controllers, and the generally-accepted benchmark for software development in assembly languages was 50 lines of verified code per day. When management was presented with proof that I was averaging 72 relatively-bug-free lines of code every day, they backed off and let me get on with the work. The junior engineers, who were writing user interfaces in C, were getting similar grief from their manager, so I added a C-language filter to the utility and convinced management that 150 lines of bug-free C code was a good day’s work. :-)
Over time, I have abandoned the DOS/Windows(tm) world completely, and I had begun to miss my source code profiler. Thus on one spring morning in 2012 when I couldn’t bear to look at another student project, I began thinking about a Linux port. When final exams were over, I sat down on the veranda with warm sunshine and cold beer—finishing the Linux port (with enhancements and documentation) in three weeks. Welcome to ’srcprof’ !
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 terminal environment.
’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.
DvdRepair is a console-based utility, which runs as either a pure, command-line utility, OR as a dialog based on the NcDialog API.
For a complete and robust replacement for std::string, please consider Gnome Toolkit’s Glib::ustring. Although it requires installation of several elements of the Gnome Toolkit, it provides an elegant solution to the modern application’s need for seamless internationalization.
Interactive Mode requires ncursesw v:5.9 or above. The ’ncursesw’ shared library is installed by default on nearly all Linux/UNIX desktop sytems; however, the ’ncursesw’ link library is usually installed only with the ncurses development package.
1) Specify the base directory using the '-a' option, and then each subdirectory by name on the command line. Example: srcprof -a -d=./Config -d=./Startup -d=./Shutdown -d=./Interface 2) Use Interactive Mode to visit and select all sources files in each individual subdirectory.
Next: Index, Previous: Technical Support, Up: Top [Contents][Index]
The SourceProfiler binary and source code are released under the GNU General Public License (GPL 3+), and the user documentation (this document) is released under the GNU Free Documentation License (FDL 1.3+):
Copyright © 1998-2015 Mahlon R. Smith, The Software Samurai
This manual describes version 0.0.18 of ’srcprof’.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".
| • GNU General Public License: | ||
| • GNU Free Documentation License: |
Next: GNU Free Documentation License, Up: Copyright Notice [Contents][Index]
Copyright © 2007 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
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.
one line to give the program's name and a brief idea of what it does. Copyright (C) year name of author This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.
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:
program Copyright (C) year name of author This program comes with ABSOLUTELY NO WARRANTY; for details type ‘show w’. This is free software, and you are welcome to redistribute it under certain conditions; type ‘show c’ for details.
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 http://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 http://www.gnu.org/philosophy/why-not-lgpl.html.
Previous: GNU General Public License, Up: Copyright Notice [Contents][Index]
Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. http://fsf.org/ Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
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 http://www.gnu.org/copyleft/.
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:
Copyright (C) year your name. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled ``GNU Free Documentation License''.
If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, replace the “with…Texts.” line with this:
with the Invariant Sections being list their titles, with
the Front-Cover Texts being list, and with the Back-Cover Texts
being list.
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
A C D E F H I L M N O P R S T U V W Z |
|---|
| Jump to: | 0
A C D E F H I L M N O P R S T U V W Z |
|---|