summaryrefslogtreecommitdiff
path: root/documentation/src
diff options
context:
space:
mode:
authorFabien Costantini <fabien@onepost.net>2008-10-17 12:42:28 +0000
committerFabien Costantini <fabien@onepost.net>2008-10-17 12:42:28 +0000
commit6ff84799a31e9ebfd0df4a6d85b79d9ce93f20a2 (patch)
tree8186e79c0f41a38eb5fd584c7949f731752d7ef1 /documentation/src
parent69dbe4ea9cf540310a276be574eb98a59102f64e (diff)
Moved latex related files to src, man files to src, updated Makefile and Doxyfile accordingly.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6453 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/src')
-rw-r--r--documentation/src/blocks.man26
-rw-r--r--documentation/src/checkers.man24
-rw-r--r--documentation/src/fltk-book.tex58
-rw-r--r--documentation/src/fltk-config.man90
-rw-r--r--documentation/src/fltk.book108
-rw-r--r--documentation/src/fltk.man55
-rw-r--r--documentation/src/fluid.man32
-rw-r--r--documentation/src/html_footer9
-rw-r--r--documentation/src/sudoku.man33
9 files changed, 435 insertions, 0 deletions
diff --git a/documentation/src/blocks.man b/documentation/src/blocks.man
new file mode 100644
index 000000000..920300708
--- /dev/null
+++ b/documentation/src/blocks.man
@@ -0,0 +1,26 @@
+.TH blocks 6 "FLTK Checkers" "15 January 2006"
+.SH NAME
+blocks \- the fltk block attack! game
+.sp
+.SH SYNOPSIS
+\fIBlocks\fR is a FLTK-based block elimination game. Stacks of
+colored blocks move from right to left as you try to eliminate
+groups adjacent blocks by clicking on them. As the game
+progresses, more colors are added (up to a maximum of 7) and the
+blocks move faster and faster.
+.SH GAME PLAY
+Press the N key to start a game. As the blocks move across the
+window, click on groups of two or more blocks to clear them - the
+larger the number of adjacent blocks, the greater the score.
+Clicking on a blocks containing a dark ball will clear all blocks
+of that color, however you will score much fewer points than a
+normal click. The game is over when the blocks reach the left
+side of the window.
+.LP
+Press the spacebar to pause the game.
+.SH SEE ALSO
+fltk(3)
+.br
+FLTK Web Site, http://www.fltk.org/
+.SH AUTHOR
+Michael R Sweet.
diff --git a/documentation/src/checkers.man b/documentation/src/checkers.man
new file mode 100644
index 000000000..097277474
--- /dev/null
+++ b/documentation/src/checkers.man
@@ -0,0 +1,24 @@
+.TH checkers 6 "FLTK Checkers" "15 January 2006"
+.SH NAME
+checkers \- the fltk checkers game
+.sp
+.SH SYNOPSIS
+\fICheckers\fR is a FLTK-based version of the game of checkers.
+The game is played on an 8x8 board with each player starting with
+12 pieces or "checkers" on opposite sides of the board. The
+computer plays the white checkers in this version of the game.
+.LP
+The object of the game is to remove all of your opponents pieces.
+Players move one of their pieces diagonally forward on each move,
+either a single space or by "jumping" an adjacent piece. Your
+opponents pieces are removed by jumping them - you can make
+multiple jumps in a single turn.
+.LP
+If a piece reaches the other side of the board, it is converted
+to a "king" which can move both forwards and backwards.
+.SH SEE ALSO
+fltk(3)
+.br
+FLTK Web Site, http://www.fltk.org/
+.SH AUTHORS
+Bill Spitzak and others.
diff --git a/documentation/src/fltk-book.tex b/documentation/src/fltk-book.tex
new file mode 100644
index 000000000..797e74096
--- /dev/null
+++ b/documentation/src/fltk-book.tex
@@ -0,0 +1,58 @@
+\documentclass[a4paper]{book}
+\usepackage{a4wide}
+\usepackage{makeidx}
+\usepackage{fancyhdr}
+\usepackage{graphicx}
+\usepackage{multicol}
+\usepackage{float}
+\usepackage{textcomp}
+\usepackage{alltt}
+\usepackage{times}
+\usepackage{ifpdf}
+\ifpdf
+\usepackage[pdftex,
+ pagebackref=true,
+ colorlinks=true,
+ linkcolor=blue,
+ unicode
+ ]{hyperref}
+\else
+\usepackage[ps2pdf,
+ pagebackref=true,
+ colorlinks=true,
+ linkcolor=blue,
+ unicode
+ ]{hyperref}
+\usepackage{pspicture}
+\fi
+\usepackage[utf8]{inputenc}
+\usepackage{doxygen}
+\makeindex
+\setcounter{tocdepth}{3}
+\renewcommand{\footrulewidth}{0.4pt}
+\begin{document}
+\begin{titlepage}
+\vspace*{6cm}
+\begin{center}
+{\Huge FLTK 1.3.0 Programming Manual}\\
+\vspace*{0.5cm}
+\begin{ImageNoCaption}
+ \mbox{\includegraphics[width=4cm]{FL200}}
+\end{ImageNoCaption}\\
+\vspace*{0.5cm}
+{\Large
+Revision 8 by Michael Sweet, Craig P. Earls,\\
+Matthias Melcher, and Bill Spitzak.}\\
+\vspace*{0.5cm}
+{\large Copyright 1998-2008 by Bill Spitzak and others.}\\
+\vspace*{3.5cm}
+{\large Generated by Doxygen 1.5.7.1}\\
+\vspace*{0.5cm}
+{\small Mon Oct 6 20:25:35 2008}\\
+\end{center}
+\end{titlepage}
+\clearemptydoublepage
+\pagenumbering{roman}
+\tableofcontents
+\clearemptydoublepage
+\pagenumbering{arabic}
diff --git a/documentation/src/fltk-config.man b/documentation/src/fltk-config.man
new file mode 100644
index 000000000..2fc3b7f09
--- /dev/null
+++ b/documentation/src/fltk-config.man
@@ -0,0 +1,90 @@
+.TH fltk\-config 1 "Fast Light Tool Kit" "6 February 2007"
+.SH NAME
+fltk\-config \- script to get information about the installed version of fltk.
+.sp
+.SH SYNOPSIS
+fltk\-config [ \-\-prefix
+.I [=DIR]
+] [ \-\-exec\-prefix
+.I [=DIR]
+] [ \-\-version ] [ \-\-api\-version ] [ \-\-use\-gl ] [ \-\-use\-images ]
+[ \-\-use\-glut ]
+[ \-\-cc ] [ \-\-cxx ]
+[ \-\-cflags ] [ \-\-cxxflags ] [ \-\-ldflags ] [ \-\-ldstaticflags ]
+[ \-\-libs ]
+[ \-D\fIname[=value]\fR ] [ \-g ] [ \-\-compile
+.I program.cxx
+]
+.SH DESCRIPTION
+\fIfltk\-config\fR is a utility script that can be used to get information
+about the current version of FLTK that is installed on the system, what
+compiler and linker options to use when building FLTK-based applications,
+and to build simple FLTK applications.
+.LP
+The following options are supported:
+.TP 5
+\-\-api\-version
+.br
+Displays the current FLTK API version number, e.g. "1.1".
+.TP 5
+\-\-cc
+.TP 5
+\-\-cxx
+.br
+Displays the C/C++ compiler that was used to compile FLTK.
+.TP 5
+\-\-cflags
+.TP 5
+\-\-cxxflags
+.br
+Displays the C/C++ compiler options to use when compiling source
+files that use FLTK.
+.TP 5
+\-\-compile \fIprogram.cxx\fR
+.br
+Compiles the source file \fIprogram.cxx\fR into \fIprogram\fR.
+This option implies "\-\-post \fIprogram\fR".
+.TP 5
+\-g
+.br
+Enables debugging information when compiling with the \fI\-\-compile\fR
+option.
+.TP 5
+\-\-ldflags
+.br
+Displays the linker options to use when linking a FLTK
+application.
+.TP 5
+\-\-ldstaticflags
+.br
+Displays the linker options to use when linking a FLTK
+application to the static FLTK libraries.
+.TP 5
+\-\-libs
+.br
+Displays the full path to the FLTK library files, to be used for
+dependency checking.
+.TP 5
+\-\-use\-gl
+.br
+Enables OpenGL support.
+.TP 5
+\-\-use\-glut
+.br
+Enables GLUT support.
+.TP 5
+\-\-use\-images
+.br
+Enables image file support.
+.TP 5
+\-\-version
+.br
+Displays the current FLTK version number, e.g. "1.1.0".
+.SH SEE ALSO
+fluid(1), fltk(3)
+.br
+FLTK Programming Manual
+.br
+FLTK Web Site, http://www.fltk.org/
+.SH AUTHORS
+Bill Spitzak and others.
diff --git a/documentation/src/fltk.book b/documentation/src/fltk.book
new file mode 100644
index 000000000..acd4fcc0c
--- /dev/null
+++ b/documentation/src/fltk.book
@@ -0,0 +1,108 @@
+#HTMLDOC 1.8.27.1
+-t pdf13 -f "fltk.pdf" --book --toclevels 2 --no-numbered --toctitle "Table of Contents" --title --titleimage "FL.gif" --linkstyle underline --size Universal --left 1.00in --right 0.50in --top 0.50in --bottom 0.50in --header .t. --header1 ... --footer h.1 --nup 1 --tocheader .t. --tocfooter ..i --duplex --portrait --color --no-pscommands --no-xrxcomments --compression=9 --jpeg=50 --fontsize 11.0 --fontspacing 1.2 --headingfont Helvetica --bodyfont Times --headfootsize 11.0 --headfootfont Helvetica --charset iso-8859-1 --links --no-embedfonts --pagemode outline --pagelayout single --firstpage c1 --pageeffect none --pageduration 10 --effectduration 1.0 --no-encryption --permissions all --owner-password "" --user-password "" --browserwidth 680 --strict --no-overflow
+preface.html
+intro.html
+basics.html
+common.html
+editor.html
+drawing.html
+events.html
+subclassing.html
+opengl.html
+fluid.html
+widgets.html
+advanced.html
+Fl.html
+Fl_Adjuster.html
+Fl_Bitmap.html
+Fl_BMP_Image.html
+Fl_Box.html
+Fl_Browser_.html
+Fl_Browser.html
+Fl_Button.html
+Fl_Chart.html
+Fl_Check_Browser.html
+Fl_Check_Button.html
+Fl_Choice.html
+Fl_Clock.html
+Fl_Clock_Output.html
+Fl_Color_Chooser.html
+Fl_Counter.html
+Fl_Dial.html
+Fl_Double_Window.html
+Fl_End.html
+Fl_File_Browser.html
+Fl_File_Chooser.html
+Fl_File_Icon.html
+Fl_File_Input.html
+Fl_Float_Input.html
+Fl_Free.html
+Fl_GIF_Image.html
+Fl_Gl_Window.html
+Fl_Group.html
+Fl_Help_Dialog.html
+Fl_Help_View.html
+Fl_Hold_Browser.html
+Fl_Image.html
+Fl_Input.html
+Fl_Input_.html
+Fl_Input_Choice.html
+Fl_Int_Input.html
+Fl_JPEG_Image.html
+Fl_Light_Button.html
+Fl_Menu_.html
+Fl_Menu_Bar.html
+Fl_Menu_Button.html
+Fl_Menu_Item.html
+Fl_Menu_Window.html
+Fl_Multi_Browser.html
+Fl_Multiline_Input.html
+Fl_Multiline_Output.html
+Fl_Output.html
+Fl_Overlay_Window.html
+Fl_Pack.html
+Fl_Pixmap.html
+Fl_PNG_Image.html
+Fl_PNM_Image.html
+Fl_Positioner.html
+Fl_Preferences.html
+Fl_Progress.html
+Fl_Repeat_Button.html
+Fl_RGB_Image.html
+Fl_Return_Button.html
+Fl_Roller.html
+Fl_Round_Button.html
+Fl_Scroll.html
+Fl_Scrollbar.html
+Fl_Secret_Input.html
+Fl_Select_Browser.html
+Fl_Shared_Image.html
+Fl_Single_Window.html
+Fl_Slider.html
+Fl_Spinner.html
+Fl_Tabs.html
+Fl_Text_Buffer.html
+Fl_Text_Display.html
+Fl_Text_Editor.html
+Fl_Tile.html
+Fl_Tiled_Image.html
+Fl_Timer.html
+Fl_Toggle_Button.html
+Fl_Tooltip.html
+Fl_Valuator.html
+Fl_Value_Input.html
+Fl_Value_Output.html
+Fl_Value_Slider.html
+Fl_Widget.html
+Fl_Window.html
+Fl_Wizard.html
+Fl_XBM_Image.html
+Fl_XPM_Image.html
+functions.html
+enumerations.html
+glut.html
+forms.html
+osissues.html
+migration.html
+license.html
+examples.html
diff --git a/documentation/src/fltk.man b/documentation/src/fltk.man
new file mode 100644
index 000000000..aac339aaa
--- /dev/null
+++ b/documentation/src/fltk.man
@@ -0,0 +1,55 @@
+.TH fltk 3 "Fast Light Tool Kit" "6 January 2002"
+.SH NAME
+fltk \- the fast light tool kit
+.sp
+.SH SYNOPSIS
+The Fast Light Tool Kit ("FLTK", pronounced "fulltick") is a
+C++ graphical user interface toolkit for the X Window
+System, MacOS(r), and Microsoft Windows(r) that supports OpenGL(r).
+It was originally developed by Mr. Bill Spitzak and is currently
+maintained by a small group of developers across the world with
+a central repository in the US.
+.LP
+FLTK is provides under the terms of the GNU Library General Public License,
+with the following exceptions:
+.IP
+1. Modifications to the FLTK configure script, config header
+file, and makefiles by themselves to support a specific platform
+do not constitute a modified or derivative work.
+.IP
+The authors do request that such modifications be
+contributed to the FLTK project - send all
+contributions to "fltk\-bugs@fltk.org".
+.IP
+2. Widgets that are subclassed from FLTK widgets do not
+constitute a derivative work.
+.IP
+3. Static linking of applications and widgets to the FLTK
+library does not constitute a derivative work and does not
+require the author to provide source code for the application or
+widget, use the shared FLTK libraries, or link their
+applications or widgets against a user-supplied version of FLTK.
+.IP
+If you link the application or widget to a modified version of
+FLTK, then the changes to FLTK must be provided under the terms
+of the LGPL in sections 1, 2, and 4.
+.IP
+4. You do not have to provide a copy of the FLTK license with
+programs that are linked to the FLTK library, nor do you have to
+identify the FLTK license in your program or documentation as
+required by section 6 of the LGPL.
+.IP
+However, programs must still identify their use of FLTK. The
+following example statement can be included in user
+documentation to satisfy this requirement:
+.IP
+[program/widget] is based in part on the work of the FLTK
+project (http://www.fltk.org).
+.SH SEE ALSO
+fltk\-config(1), fluid(1)
+.br
+FLTK Programming Manual
+.br
+FLTK Web Site, http://www.fltk.org/
+.SH AUTHORS
+Bill Spitzak and others.
diff --git a/documentation/src/fluid.man b/documentation/src/fluid.man
new file mode 100644
index 000000000..cb6849bc3
--- /dev/null
+++ b/documentation/src/fluid.man
@@ -0,0 +1,32 @@
+.TH fluid 1 "Fast Light Tool Kit" "6 January 2002"
+.SH NAME
+fluid \- the fast light user-interface designer
+.sp
+.SH SYNOPSIS
+fluid [ \-c [ \-o
+.I code-filename
+\-h
+.I header-filename
+] ] [
+.I filename.fl
+]
+.fi
+.SH DESCRIPTION
+\fIfluid\fR is an interactive GUI designer for FLTK. When run
+with no arguments or with a filename, \fIfluid\fR will display
+the GUI hierarchy and any windows defined in the file.
+Functions, classes, windows, and GUI components can be
+manipulated as needed.
+.LP
+When used with the \fI\-c\fR option, \fIfluid\fR will create the
+necessary C++ header and code files in the current directory.
+You can override the default extensions, filenames, and
+directories using the \fI\-o\fR and \fI\-h\fR options.
+.SH SEE ALSO
+fltk\-config(1), fltk(3)
+.br
+FLTK Programming Manual, Chapter 9
+.br
+FLTK Web Site, http://www.fltk.org/
+.SH AUTHORS
+Bill Spitzak and others.
diff --git a/documentation/src/html_footer b/documentation/src/html_footer
new file mode 100644
index 000000000..9c15979d7
--- /dev/null
+++ b/documentation/src/html_footer
@@ -0,0 +1,9 @@
+<hr>
+<address><small>
+<!-- $datetime. -->
+<a href="http://www.fltk.org"><img src="tiny.gif" align="bottom" alt="FLTK"></a>
+&copy; 1998-2008 by Bill Spitzak and others.&nbsp;&nbsp;&nbsp;
+Permission is granted to reproduce this manual or any portion for
+any purpose, provided this copyright and permission notice are preserved.
+</small></address>
+</body></html>
diff --git a/documentation/src/sudoku.man b/documentation/src/sudoku.man
new file mode 100644
index 000000000..32d496e8e
--- /dev/null
+++ b/documentation/src/sudoku.man
@@ -0,0 +1,33 @@
+.TH sudoku 6 "FLTK Sudoku" "15 January 2006"
+.SH NAME
+sudoku \- the fltk sudoku game
+.sp
+.SH SYNOPSIS
+\fISudoku\fR is a FLTK-based version of the game of Sudoku.
+Sudoku (pronounced soo-dough-coo with the emphasis on the first
+syllable) is a simple number-based puzzle/game played on a 9x9
+grid that is divided into 3x3 subgrids. The goal is to enter a
+number from 1 to 9 in each cell so that each number appears only
+once in each column and row.
+.LP
+At the start of a new game, Sudoku fills in a random selection of
+cells for you - the number of cells depends on the difficulty
+level you use. Click in any of the empty cells or use the arrow
+keys to highlight individual cells and press a number from 1 to 9
+to fill in the cell. To clear a cell, press 0, Delete, or
+Backspace. As you complete each subgrid, correct subgrids are
+highlighted in green. When you have successfully completed all
+subgrids, the entire puzzle is highlighted until you start a new
+game.
+.LP
+As you work to complete the puzzle, you can display possible
+solutions inside each cell by holding the Shift key and pressing
+each number in turn. Repeat the process to remove individual
+numbers, or press a number without the Shift key to replace them
+with the actual number to use.
+.SH SEE ALSO
+fltk(3)
+.br
+FLTK Web Site, http://www.fltk.org/
+.SH AUTHOR
+Michael R Sweet.