Salome HOME
add doc/build for EZ direct html or pdf
[tools/sat.git] / doc / build / latex / salomeTools.toc
1 \babel@toc {english}{}
2 \contentsline {chapter}{\numberline {1}Quick start}{3}{chapter.1}
3 \contentsline {section}{\numberline {1.1}Installation}{3}{section.1.1}
4 \contentsline {section}{\numberline {1.2}Configuration}{3}{section.1.2}
5 \contentsline {subsection}{\numberline {1.2.1}Syntax}{3}{subsection.1.2.1}
6 \contentsline {subsection}{\numberline {1.2.2}Description}{3}{subsection.1.2.2}
7 \contentsline {subsubsection}{VARS section}{3}{subsubsection*.3}
8 \contentsline {subsubsection}{PRODUCTS section}{4}{subsubsection*.4}
9 \contentsline {subsubsection}{APPLICATION section}{4}{subsubsection*.5}
10 \contentsline {subsubsection}{USER section}{4}{subsubsection*.6}
11 \contentsline {section}{\numberline {1.3}Usage of SAlomeTools}{4}{section.1.3}
12 \contentsline {subsection}{\numberline {1.3.1}Usage}{4}{subsection.1.3.1}
13 \contentsline {subsubsection}{Options of sat}{4}{subsubsection*.7}
14 \contentsline {paragraph}{\emph {--help or -h}}{5}{paragraph*.8}
15 \contentsline {paragraph}{\emph {--debug or -g}}{5}{paragraph*.9}
16 \contentsline {paragraph}{\emph {--verbose or -v}}{5}{paragraph*.10}
17 \contentsline {subsection}{\numberline {1.3.2}Build a SALOME product}{5}{subsection.1.3.2}
18 \contentsline {subsubsection}{Get the list of available products}{5}{subsubsection*.11}
19 \contentsline {subsubsection}{Prepare sources of a product}{5}{subsubsection*.12}
20 \contentsline {subsubsection}{Compile SALOME}{5}{subsubsection*.13}
21 \contentsline {chapter}{\numberline {2}List of Commands}{7}{chapter.2}
22 \contentsline {section}{\numberline {2.1}Command config}{7}{section.2.1}
23 \contentsline {subsection}{\numberline {2.1.1}Description}{7}{subsection.2.1.1}
24 \contentsline {subsection}{\numberline {2.1.2}Usage}{7}{subsection.2.1.2}
25 \contentsline {subsection}{\numberline {2.1.3}Some useful configuration pathes}{8}{subsection.2.1.3}
26 \contentsline {section}{\numberline {2.2}Command prepare}{8}{section.2.2}
27 \contentsline {subsection}{\numberline {2.2.1}Description}{8}{subsection.2.2.1}
28 \contentsline {subsection}{\numberline {2.2.2}Remarks}{8}{subsection.2.2.2}
29 \contentsline {subsubsection}{VCS bases (git, svn, cvs)}{8}{subsubsection*.14}
30 \contentsline {subsubsection}{Dev mode}{9}{subsubsection*.15}
31 \contentsline {subsection}{\numberline {2.2.3}Usage}{9}{subsection.2.2.3}
32 \contentsline {subsection}{\numberline {2.2.4}Some useful configuration pathes}{9}{subsection.2.2.4}
33 \contentsline {section}{\numberline {2.3}Command compile}{10}{section.2.3}
34 \contentsline {subsection}{\numberline {2.3.1}Description}{10}{subsection.2.3.1}
35 \contentsline {subsection}{\numberline {2.3.2}Usage}{10}{subsection.2.3.2}
36 \contentsline {subsection}{\numberline {2.3.3}Some useful configuration pathes}{11}{subsection.2.3.3}
37 \contentsline {section}{\numberline {2.4}Command launcher}{11}{section.2.4}
38 \contentsline {subsection}{\numberline {2.4.1}Description}{11}{subsection.2.4.1}
39 \contentsline {subsection}{\numberline {2.4.2}Usage}{11}{subsection.2.4.2}
40 \contentsline {subsection}{\numberline {2.4.3}Configuration}{11}{subsection.2.4.3}
41 \contentsline {section}{\numberline {2.5}Command application}{12}{section.2.5}
42 \contentsline {subsection}{\numberline {2.5.1}Description}{12}{subsection.2.5.1}
43 \contentsline {subsection}{\numberline {2.5.2}Usage}{12}{subsection.2.5.2}
44 \contentsline {subsection}{\numberline {2.5.3}Some useful configuration pathes}{12}{subsection.2.5.3}
45 \contentsline {section}{\numberline {2.6}Command log}{13}{section.2.6}
46 \contentsline {subsection}{\numberline {2.6.1}Description}{13}{subsection.2.6.1}
47 \contentsline {subsection}{\numberline {2.6.2}Usage}{13}{subsection.2.6.2}
48 \contentsline {subsection}{\numberline {2.6.3}Some useful configuration pathes}{13}{subsection.2.6.3}
49 \contentsline {section}{\numberline {2.7}Command environ}{13}{section.2.7}
50 \contentsline {subsection}{\numberline {2.7.1}Description}{13}{subsection.2.7.1}
51 \contentsline {subsection}{\numberline {2.7.2}Usage}{14}{subsection.2.7.2}
52 \contentsline {subsection}{\numberline {2.7.3}Configuration}{14}{subsection.2.7.3}
53 \contentsline {section}{\numberline {2.8}Command clean}{15}{section.2.8}
54 \contentsline {subsection}{\numberline {2.8.1}Description}{15}{subsection.2.8.1}
55 \contentsline {subsection}{\numberline {2.8.2}Usage}{15}{subsection.2.8.2}
56 \contentsline {subsection}{\numberline {2.8.3}Availables options}{16}{subsection.2.8.3}
57 \contentsline {subsection}{\numberline {2.8.4}Some useful configuration pathes}{16}{subsection.2.8.4}
58 \contentsline {section}{\numberline {2.9}Command package}{16}{section.2.9}
59 \contentsline {subsection}{\numberline {2.9.1}Description}{16}{subsection.2.9.1}
60 \contentsline {subsection}{\numberline {2.9.2}Usage}{16}{subsection.2.9.2}
61 \contentsline {subsection}{\numberline {2.9.3}Some useful configuration pathes}{17}{subsection.2.9.3}
62 \contentsline {section}{\numberline {2.10}Command generate}{17}{section.2.10}
63 \contentsline {subsection}{\numberline {2.10.1}Description}{17}{subsection.2.10.1}
64 \contentsline {subsection}{\numberline {2.10.2}Remarks}{18}{subsection.2.10.2}
65 \contentsline {subsection}{\numberline {2.10.3}Usage}{18}{subsection.2.10.3}
66 \contentsline {chapter}{\numberline {3}Developer documentation}{19}{chapter.3}
67 \contentsline {section}{\numberline {3.1}Add a user custom command}{19}{section.3.1}
68 \contentsline {subsection}{\numberline {3.1.1}Introduction}{19}{subsection.3.1.1}
69 \contentsline {subsection}{\numberline {3.1.2}Basic requirements}{19}{subsection.3.1.2}
70 \contentsline {subsection}{\numberline {3.1.3}HowTo access salomeTools config and other commands}{20}{subsection.3.1.3}
71 \contentsline {subsection}{\numberline {3.1.4}HowTo logger}{20}{subsection.3.1.4}
72 \contentsline {subsection}{\numberline {3.1.5}HELLO example}{20}{subsection.3.1.5}
73 \contentsline {chapter}{\numberline {4}Code documentation}{23}{chapter.4}
74 \contentsline {section}{\numberline {4.1}src}{23}{section.4.1}
75 \contentsline {subsection}{\numberline {4.1.1}src Package}{23}{subsection.4.1.1}
76 \contentsline {subsubsection}{\texttt {src} Package}{23}{subsubsection*.16}
77 \contentsline {subsubsection}{\texttt {ElementTree} Module}{25}{subsubsection*.59}
78 \contentsline {subsubsection}{\texttt {architecture} Module}{26}{subsubsection*.91}
79 \contentsline {subsubsection}{\texttt {compilation} Module}{27}{subsubsection*.98}
80 \contentsline {subsubsection}{\texttt {debug} Module}{28}{subsubsection*.117}
81 \contentsline {subsubsection}{\texttt {environment} Module}{29}{subsubsection*.131}
82 \contentsline {subsubsection}{\texttt {fileEnviron} Module}{33}{subsubsection*.169}
83 \contentsline {subsubsection}{\texttt {fork} Module}{38}{subsubsection*.234}
84 \contentsline {subsubsection}{\texttt {logger} Module}{38}{subsubsection*.240}
85 \contentsline {subsubsection}{\texttt {options} Module}{40}{subsubsection*.253}
86 \contentsline {subsubsection}{\texttt {printcolors} Module}{41}{subsubsection*.259}
87 \contentsline {subsubsection}{\texttt {product} Module}{42}{subsubsection*.272}
88 \contentsline {subsubsection}{\texttt {pyconf} Module}{46}{subsubsection*.302}
89 \contentsline {subsubsection}{\texttt {system} Module}{53}{subsubsection*.374}
90 \contentsline {subsubsection}{\texttt {template} Module}{55}{subsubsection*.380}
91 \contentsline {subsubsection}{\texttt {test\_module} Module}{55}{subsubsection*.385}
92 \contentsline {subsubsection}{\texttt {xmlManager} Module}{56}{subsubsection*.405}
93 \contentsline {subsubsection}{Subpackages}{57}{subsubsection*.419}
94 \contentsline {paragraph}{colorama Package}{57}{paragraph*.420}
95 \contentsline {subparagraph}{\texttt {colorama} Package}{57}{subparagraph*.421}
96 \contentsline {subparagraph}{\texttt {ansi} Module}{57}{subparagraph*.423}
97 \contentsline {subparagraph}{\texttt {ansitowin32} Module}{59}{subparagraph*.476}
98 \contentsline {subparagraph}{\texttt {initialise} Module}{60}{subparagraph*.494}
99 \contentsline {subparagraph}{\texttt {win32} Module}{60}{subparagraph*.501}
100 \contentsline {subparagraph}{\texttt {winterm} Module}{60}{subparagraph*.504}
101 \contentsline {chapter}{\numberline {5}Release Notes}{63}{chapter.5}
102 \contentsline {section}{\numberline {5.1}Release notes}{63}{section.5.1}
103 \contentsline {chapter}{Python Module Index}{65}{section*.532}
104 \contentsline {chapter}{Index}{67}{section*.533}