Skip to content
Snippets Groups Projects
Commit bed7021b authored by Christophe Geuzaine's avatar Christophe Geuzaine
Browse files

doc updates

parent 81a0c3c5
No related branches found
No related tags found
No related merge requests found
...@@ -86,19 +86,21 @@ Build Gmsh from the command line ...@@ -86,19 +86,21 @@ Build Gmsh from the command line
to build a version of Gmsh without the FLTK graphical interface. to build a version of Gmsh without the FLTK graphical interface.
* You can keep multiple builds with different build options at the * You can keep multiple builds with different build options at the
same time. For example, you could configure a full release graphical same time. For example, you could configure a debug graphical build
build in a "bin" subdirectory with in a "bin" subdirectory with
cd bin cd bin
cmake -DCMAKE_BUILD_TYPE=Release .. cmake -DCMAKE_BUILD_TYPE=Debug ..
make make
make install make install
and a stripped-down debug library build in a "lib" subdirectory with and static and dynamic non-graphical release libraries in a "lib"
subdirectory with
cd lib cd lib
cmake -DCMAKE_BUILD_TYPE=Debug -DENABLE_FLTK=0 -DENABLE_OCC=0 .. cmake -DCMAKE_BUILD_TYPE=Release -DENABLE_FLTK=0 -DENABLE_OCC=0 ..
make lib make lib
make shared
make install/fast make install/fast
* To see a detailed compilation log use * To see a detailed compilation log use
......
...@@ -159,7 +159,6 @@ is distributed under the terms of ...@@ -159,7 +159,6 @@ is distributed under the terms of
the <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public the <a href="http://www.gnu.org/copyleft/gpl.html">GNU General Public
License (GPL)</a> (with an <a href="/gmsh/doc/LICENSE.txt">exception</a> License (GPL)</a> (with an <a href="/gmsh/doc/LICENSE.txt">exception</a>
to allow for easier linking with external libraries). to allow for easier linking with external libraries).
<p> <p>
In short, this means that everyone is free to use Gmsh and to In short, this means that everyone is free to use Gmsh and to
redistribute it on a free basis. Gmsh is not in the public domain; it redistribute it on a free basis. Gmsh is not in the public domain; it
...@@ -168,13 +167,11 @@ is copyrighted and there are restrictions on its distribution (see the ...@@ -168,13 +167,11 @@ is copyrighted and there are restrictions on its distribution (see the
associated <a href="http://www.gnu.org/copyleft/gpl-faq.html">FAQ</a>). associated <a href="http://www.gnu.org/copyleft/gpl-faq.html">FAQ</a>).
For example, you cannot integrate this version of Gmsh (in full or in For example, you cannot integrate this version of Gmsh (in full or in
parts) in any <em>closed-source</em> software you plan to distribute parts) in any <em>closed-source</em> software you plan to distribute
(commercially or not). (commercially or not). If you want to integrate parts of Gmsh into a
<p> closed-source software, or want to sell a modified closed-source
If you want to integrate Gmsh into a closed-source software, or want version of Gmsh, you will need to obtain a different
to sell a modified closed-source version of Gmsh, please contact us in license. Please <a href="/">contact us directly</a> for more
person. You can purchase a version of Gmsh under a different license, information.
with "no strings attached" (for example allowing you to take parts of
Gmsh and integrate them into your own proprietary code).
<h2><a name="Screenshots"></a>Screenshots</h2> <h2><a name="Screenshots"></a>Screenshots</h2>
......
...@@ -92,7 +92,7 @@ all copies. ...@@ -92,7 +92,7 @@ all copies.
@c ========================================================================= @c =========================================================================
@ifnottex @ifnottex
@node Top, Copying conditions, (dir), (dir) @node Top, Obtaining Gmsh, (dir), (dir)
@top Gmsh @top Gmsh
Christophe Geuzaine and Jean-Fran@,{c}ois Remacle Christophe Geuzaine and Jean-Fran@,{c}ois Remacle
...@@ -107,6 +107,7 @@ for Gmsh @value{GMSH-VERSION} (@today{}). ...@@ -107,6 +107,7 @@ for Gmsh @value{GMSH-VERSION} (@today{}).
@c ========================================================================= @c =========================================================================
@menu @menu
* Obtaining Gmsh:: Where to get your copy of Gmsh
* Copying conditions:: Terms and conditions of use * Copying conditions:: Terms and conditions of use
* Overview:: What is Gmsh? * Overview:: What is Gmsh?
* How to read this manual?:: Which parts of this manual should you read (if any)? * How to read this manual?:: Which parts of this manual should you read (if any)?
...@@ -261,21 +262,41 @@ Frequently asked questions ...@@ -261,21 +262,41 @@ Frequently asked questions
@end detailmenu @end detailmenu
@end menu @end menu
@c =========================================================================
@c Obtaining Gmsh
@c =========================================================================
@node Obtaining Gmsh, Copying conditions, Top, Top
@unnumbered Obtaining Gmsh
@cindex Web site
@cindex Internet address
@cindex Download
The source code and various pre-compiled versions of Gmsh (for Unix,
Windows and Mac OS) can be downloaded from @uref{http://geuz.org/gmsh/}.
Gmsh is also directly available in pre-packaged form in various Linux
and BSD distributions (Debian, Ubuntu, FreeBSD, ...).
If you use Gmsh, we would appreciate that you mention it in your work by
citing the following paper: ``C. Geuzaine and J.-F. Remacle, @emph{Gmsh:
a three-dimensional finite element mesh generator with built-in pre- and
post-processing facilities}. International Journal for Numerical Methods
in Engineering, Volume 79, Issue 11, pages 1309-1331, 2009''. A
preprint of that paper as well as other references and the latest news
about Gmsh development are available on
@uref{http://geuz.org/gmsh/}.
@c ========================================================================= @c =========================================================================
@c Copying Conditions @c Copying Conditions
@c ========================================================================= @c =========================================================================
@node Copying conditions, Overview, Top, Top @node Copying conditions, Overview, Obtaining Gmsh, Top
@unnumbered Copying conditions @unnumbered Copying conditions
@cindex Copyright @cindex Copyright
@cindex License @cindex License
@cindex Web site
@cindex Internet address
@cindex Mailing list
@cindex Download
Gmsh is ``free software''; this means that everyone is free to use it and Gmsh is ``free software''; this means that everyone is free to use it and
to redistribute it on a free basis. Gmsh is not in the public domain; it is to redistribute it on a free basis. Gmsh is not in the public domain; it is
copyrighted and there are restrictions on its distribution, but these copyrighted and there are restrictions on its distribution, but these
...@@ -306,22 +327,10 @@ information about this license is available from the GNU Project webpage ...@@ -306,22 +327,10 @@ information about this license is available from the GNU Project webpage
@uref{http://www.gnu.org/copyleft/gpl-faq.html}. Detailed copyright @uref{http://www.gnu.org/copyleft/gpl-faq.html}. Detailed copyright
information can be found in @ref{Copyright and credits}. information can be found in @ref{Copyright and credits}.
The source code and various pre-compiled versions of Gmsh (for Unix, Windows If you want to integrate parts of Gmsh into a closed-source software, or
and Mac OS) can be downloaded from the webpage @uref{http://geuz.org/gmsh/}. want to sell a modified closed-source version of Gmsh, you will need to
obtain a different license. Please @uref{http://geuz.org, contact us
If you use Gmsh, we would appreciate that you mention it in your directly} for more information.
work. References, as well as the latest news about Gmsh development, are
always available on @uref{http://geuz.org/gmsh/}. Please send all
Gmsh-related questions to the public Gmsh mailing list at
@email{gmsh@@geuz.org}.
@sp 1
If you want to integrate Gmsh into a closed-source software, or want to sell
a modified closed-source version of Gmsh, please contact one of the
authors. You can purchase a version of Gmsh under a different license, with
``no strings attached'' (for example allowing you to take parts of Gmsh and
integrate them into your own proprietary code).
@c ========================================================================= @c =========================================================================
@c Overview @c Overview
...@@ -570,15 +579,14 @@ developers}) to remedy the aforementioned (and all other) shortcomings! ...@@ -570,15 +579,14 @@ developers}) to remedy the aforementioned (and all other) shortcomings!
@cindex Authors, e-mail @cindex Authors, e-mail
@cindex E-mail, authors @cindex E-mail, authors
If you think you have found a bug in Gmsh, you can report it by If you think you have found a bug in Gmsh, you can report it by email to
electronic mail to the Gmsh mailing list at @email{gmsh@@geuz.org}, or the Gmsh mailing list at @email{gmsh@@geuz.org}, or file it directly
file it directly into our bug tracking system at into our bug tracking database at @url{https://geuz.org/trac/gmsh/report}
@url{https://geuz.org/trac/gmsh/report} (login: gmsh, password: gmsh). (login: gmsh, password: gmsh). Please send as precise a description of
Please send as precise a description of the problem as you can, the problem as you can, including sample input files that produce the
including sample input files that produce the bug. Don't forget to bug. Don't forget to mention both the version of Gmsh and the version of
mention both the version of Gmsh and the version of your operation your operation system (@pxref{Command-line options} to see how to get
system (@pxref{Command-line options} to see how to get this this information).
information).
See @ref{Frequently asked questions}, and the bug tracking system to see See @ref{Frequently asked questions}, and the bug tracking system to see
which problems we already know about. which problems we already know about.
...@@ -635,7 +643,11 @@ Application Programming Interface (API). No complete documentation of ...@@ -635,7 +643,11 @@ Application Programming Interface (API). No complete documentation of
this API is available yet; a good starting point is @ref{Source code this API is available yet; a good starting point is @ref{Source code
structure}, which gives a short introduction to Gmsh's internal source structure}, which gives a short introduction to Gmsh's internal source
code structure. Then have a look e.g. at the examples in the code structure. Then have a look e.g. at the examples in the
@file{utils/api_demos/} directory in the source code. @file{utils/api_demos/} directory in the source code. Due to the many
possible configuration options (and associated external dependencies),
we currently do not distibute precompiled versions of the Gmsh
library. To build the library see the instructions in the top-level
@file{README.txt} file in the source distribution.
@c ------------------------------------------------------------------------- @c -------------------------------------------------------------------------
@c Syntactic rules used in the manual @c Syntactic rules used in the manual
...@@ -4862,9 +4874,9 @@ In English people tend to pronounce `Gmsh' as ``gee-mesh''. ...@@ -4862,9 +4874,9 @@ In English people tend to pronounce `Gmsh' as ``gee-mesh''.
@item Where can I find more information? @item Where can I find more information?
@url{http://geuz.org/gmsh} is the primary location to obtain information @url{http://geuz.org/gmsh} is the primary location to obtain information
about Gmsh. You will for example find the complete reference manual as about Gmsh. There you will for example find the complete reference
well as a searchable archive of the Gmsh mailing list manual, a bug tracking database and a searchable archive of the Gmsh
(@email{gmsh@@geuz.org}) on this web site. mailing list (@email{gmsh@@geuz.org}).
@end enumerate @end enumerate
@c ------------------------------------------------------------------------- @c -------------------------------------------------------------------------
......
...@@ -3,15 +3,16 @@ INC = -I/usr/local/include -I. ...@@ -3,15 +3,16 @@ INC = -I/usr/local/include -I.
GMSH = -L/usr/local/lib -lGmsh GMSH = -L/usr/local/lib -lGmsh
GLUT = -framework OpenGL -framework GLUT -framework Cocoa -framework ApplicationServices GLUT = -framework OpenGL -framework GLUT -framework Cocoa -framework ApplicationServices
#GLUT = -lGLUT -lGLU -lGL -lX11 #GLUT = -lGLUT -lGLU -lGL -lX11
OCC = /Users/remacle/SOURCES/opencascade/lib/libTKSTEP.a /Users/remacle/SOURCES/opencascade/lib/libTKSTEP209.a /Users/remacle/SOURCES/opencascade/lib/libTKSTEPAttr.a /Users/remacle/SOURCES/opencascade/lib/libTKSTEPBase.a /Users/remacle/SOURCES/opencascade/lib/libTKIGES.a /Users/remacle/SOURCES/opencascade/lib/libTKXSBase.a /Users/remacle/SOURCES/opencascade/lib/libTKOffset.a /Users/remacle/SOURCES/opencascade/lib/libTKFeat.a /Users/remacle/SOURCES/opencascade/lib/libTKFillet.a /Users/remacle/SOURCES/opencascade/lib/libTKBool.a /Users/remacle/SOURCES/opencascade/lib/libTKShHealing.a /Users/remacle/SOURCES/opencascade/lib/libTKMesh.a /Users/remacle/SOURCES/opencascade/lib/libTKHLR.a /Users/remacle/SOURCES/opencascade/lib/libTKBO.a /Users/remacle/SOURCES/opencascade/lib/libTKPrim.a /Users/remacle/SOURCES/opencascade/lib/libTKTopAlgo.a /Users/remacle/SOURCES/opencascade/lib/libTKGeomAlgo.a /Users/remacle/SOURCES/opencascade/lib/libTKBRep.a /Users/remacle/SOURCES/opencascade/lib/libTKGeomBase.a /Users/remacle/SOURCES/opencascade/lib/libTKG3d.a /Users/remacle/SOURCES/opencascade/lib/libTKG2d.a /Users/remacle/SOURCES/opencascade/lib/libTKAdvTools.a /Users/remacle/SOURCES/opencascade/lib/libTKMath.a /Users/remacle/SOURCES/opencascade/lib/libTKernel.a OCC = -L/usr/local/opencascade/lib -L/Users/remacle/SOURCES/opencascade/lib -lTKSTEP -lTKSTEP209 -lTKSTEPAttr -lTKSTEPBase -lTKIGES -lTKXSBase -lTKOffset -lTKFeat -lTKFillet -lTKBool -lTKShHealing -lTKMesh -lTKHLR -lTKBO -lTKPrim -lTKTopAlgo -lTKGeomAlgo -lTKBRep -lTKGeomBase -lTKG3d -lTKG2d -lTKAdvTools -lTKMath -lTKernel
TAUCS = -L/Users/remacle/SOURCES/gmsh/contrib/taucs/lib -L/home/gaetan/develop/gmsh/contrib/taucs/lib/linux -ltaucs
mainElasticity: mainElasticity.cpp mainElasticity: mainElasticity.cpp
g++ ${FLAGS} -o mainElasticity ${INC} mainElasticity.cpp\ g++ ${FLAGS} -o mainElasticity ${INC} mainElasticity.cpp\
${GMSH} -llapack -lblas -lm -lmetis -L/home/gaetan/develop/gmsh/contrib/taucs/lib/linux -ltaucs ${GMSH} -llapack -lblas -lm -lmetis ${TAUCS}
mainCartesian: mainCartesian.cpp mainCartesian: mainCartesian.cpp
g++ ${FLAGS} -o mainCartesian ${INC} mainCartesian.cpp\ g++ ${FLAGS} -o mainCartesian ${INC} mainCartesian.cpp\
${GMSH} -llapack -lblas -lm -L/Users/remacle/SOURCES/gmsh/contrib/taucs/lib -ltaucs ${OCC} ${GMSH} -llapack -lblas -lm ${OCC} ${GLUT}
mainSimple: mainSimple.cpp mainSimple: mainSimple.cpp
g++ ${FLAGS} -o mainSimple ${INC} mainSimple.cpp\ g++ ${FLAGS} -o mainSimple ${INC} mainSimple.cpp\
...@@ -31,7 +32,7 @@ mainPost: mainPost.cpp ...@@ -31,7 +32,7 @@ mainPost: mainPost.cpp
mainLevelset: mainLevelset.cpp mainLevelset: mainLevelset.cpp
g++ ${FLAGS} -o mainLevelset ${INC} mainLevelset.cpp\ g++ ${FLAGS} -o mainLevelset ${INC} mainLevelset.cpp\
${GMSH} -llapack -lblas -lm -lmetis -L/home/gaetan/develop/gmsh/contrib/taucs/lib/linux -ltaucs ${GMSH} -llapack -lblas -lm -lmetis ${TAUCS}
clean: clean:
rm -rf mainSimple mainAntTweakBar mainGlut mainPost mainLevelset\ rm -rf mainSimple mainAntTweakBar mainGlut mainPost mainLevelset\
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment