* doc/sdccman.lyx:
[fw/sdcc] / doc / sdccman.lyx
index ca65156794d0981dd8ee2730bda950570a41a503..12c56e8d9be51ea0effafd2b43463bb9fd9808ab 100644 (file)
@@ -163,7 +163,7 @@ C
 \emph on
 C
 \emph default
-ompiler) is free open source, retargettable, optimizing ANSI-C compiler
+ompiler) is free open source, retargettable, optimizing ANSI-C compiler
  by 
 \series bold
 Sandeep Dutta
@@ -676,13 +676,14 @@ status collapsed
 \newline
 
 \newline
-SDCC also comes with a companion source level debugger SDCDB, the debugger
- currently uses ucSim a freeware simulator for 8051 and other micro-controllers.<
+SDCC also comes with a companion source level debugger SDCDB.
+ The debugger currently uses ucSim, a free open source simulator for 8051
+ and other micro-controllers.
 \newline
 
 \newline
-
-The latest version can be downloaded from 
+The latest SDCC version can be downloaded from
 \begin_inset LatexCommand \url{http://sdcc.sourceforge.net/snap.php}
 
 \end_inset
@@ -730,11 +731,11 @@ freeware
 \emph default
 ; source code for all the sub-packages (pre-processor, assemblers, linkers
  etc) is distributed with the package.
- This documentation is maintained using a freeware word processor (LyX).
+ This documentation is maintained using a free open source word processor
+ (LyX).
 \newline
-This
- program is free software; you can redistribute it and/or modify it under
- the terms of the GNU General Public License
+This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License
 \begin_inset LatexCommand \index{GNU General Public License, GPL}
 
 \end_inset
@@ -3922,7 +3923,7 @@ Type
 \end_layout
 
 \begin_layout Subsection
-Building SDCC on OSX 2.x
+Building SDCC on Mac OS X
 \end_layout
 
 \begin_layout Standard
@@ -3930,8 +3931,8 @@ Follow the instruction for Linux.
 \newline
 
 \newline
-On OSX 2.x it was reported, that the default
- gcc (version 3.1 20020420 (prerelease)) fails to compile SDCC.
+On Mac OS X 10.2.x it was reported, that the
default gcc (version 3.1 20020420 (prerelease)) fails to compile SDCC.
  Fortunately there's also gcc 2.9.x installed, which works fine.
  This compiler can be selected by running 'configure' with:
 \end_layout
@@ -5380,7 +5381,7 @@ S51
 
 \end_inset
 
- is a freeware, opensource simulator developed by Daniel Drotos.
+ is a free open source simulator developed by Daniel Drotos.
  The simulator is built as part of the build process.
  For more information visit Daniel's web site at: 
 \begin_inset LatexCommand \url{http://mazsola.iit.uni-miskolc.hu/~drdani/embedded/s51}
@@ -9030,11 +9031,74 @@ status collapsed
 
  
 \series default
-The output path resp.
file where everything will be placed.
+The output path where everything will be placed or the file name used for
all generated output files.
  If the parameter is a path, it must have a trailing slash (or backslash
  for the Windows binaries) to be recognized as a path.
+
+\emph on
+\emph default
+Note for Windows users: if the path contains spaces, it should be surrounded
+ by quotes.
+ The trailing backslash should be doubled in order to prevent escaping the
+ final quote, for example: 
+\emph on
+-o 
+\begin_inset Quotes sld
+\end_inset
+
+F:
+\backslash
+Projects
+\backslash
+test3
+\backslash
+output 1
+\backslash
+
+\backslash
+
+\begin_inset Quotes srd
+\end_inset
+
+
+\emph default
+ or put after the final quote, for example: 
+\emph on
+-o 
+\begin_inset Quotes sld
+\end_inset
+
+F:
+\backslash
+Projects
+\backslash
+test3
+\backslash
+output 1
+\begin_inset Quotes srd
+\end_inset
+
+
+\backslash
+
+\emph default
+.
+ The path using slashes for directory delimiters can be used too, for example:
  
+\emph on
+-o 
+\begin_inset Quotes sld
+\end_inset
+
+F:/Projects/test3/output 1/
+\begin_inset Quotes srd
+\end_inset
+
+
+\emph default
+.
 \end_layout
 
 \begin_layout List
@@ -9629,14 +9693,14 @@ status collapsed
 
 \end_inset
 
--no-peep-comments
-\begin_inset LatexCommand \index{-\/-no-peep-comments}
+-fverbose-asm
+\begin_inset LatexCommand \index{-\/-no-gen-comments}
 
 \end_inset
 
 
 \series default
Will not include peep-hole comments in the generated files.
Include code generator and peep-hole comments in the generated asm files.
 \end_layout
 
 \begin_layout List
@@ -9656,14 +9720,15 @@ status collapsed
 
 \end_inset
 
--no-gen-comments
-\begin_inset LatexCommand \index{-\/-no-gen-comments}
+-no-peep-comments
+\begin_inset LatexCommand \index{-\/-no-peep-comments}
 
 \end_inset
 
 
 \series default
- Will not include code generator comments in the generated files.
+ Don't include peep-hole comments in the generated asm files even if --fverbose-
+asm option is specified.
 \end_layout
 
 \begin_layout List
@@ -10067,7 +10132,7 @@ status collapsed
 
 \InsetSpace ~
 <Name> The name to be used for the const
-\begin_inset LatexCommand \index{code}
+\begin_inset LatexCommand \index{const}
 
 \end_inset
 
@@ -21108,24 +21173,6 @@ disable_warning
 \end_inset
 
  - the compiler will not warn you anymore about warning number <nnnn>.
-\begin_inset Note Note
-status open
-
-\begin_layout Itemize
-\begin_inset Quotes sld
-\end_inset
-
-For list of warnings and corresponding codes, see err_warn.txt
-\begin_inset Quotes srd
-\end_inset
-
- This list should probably be part of the manual? See Patch #1697136 
-\end_layout
-
-\end_inset
-
-.
 \end_layout
 
 \begin_layout Itemize
@@ -22756,7 +22803,7 @@ status collapsed
 
 \end_inset
 
--debug-extra
+-debug-xtra
 \begin_inset LatexCommand \index{PIC14!Options!-\/-debug-extra}
 
 \end_inset
@@ -24819,7 +24866,7 @@ Before using SDCC/pic16 there are some libraries that need to be compiled.
 \end_layout
 
 \begin_layout Standard
-The steps to compile the pic16 libraries under Linux are:
+The steps to compile the pic16 libraries under Linux and Mac OS X are:
 \end_layout
 
 \begin_layout LyX-Code
@@ -31988,7 +32035,7 @@ regression tests
 \end_inset
 
  check that SDCC itself compiles flawlessly on several host platforms (i386,
- Opteron, 64 bit Alpha, ppc64, MacOS X on PPC, Solaris on Sparc) and checks
+ Opteron, 64 bit Alpha, ppc64, Mac OS X on PPC, Solaris on Sparc) and checks
  the quality of the code generated by SDCC by running the code for several
  target platforms through simulators.
  The regression test suite comprises more than 100 files which expand to
@@ -32167,8 +32214,8 @@ not tie students to a specific host platform and instead allow them to use
 \emph on
 their
 \emph default
- choice (among them Alpha, i386, i386_64, MacOs, Mips, Sparc, Windows and
- eventually 
+ choice (among them Alpha, i386, i386_64, Mac OS X, Mips, Sparc, Windows
and eventually 
 \begin_inset LatexCommand \url[OLPC]{http://www.laptop.org}
 
 \end_inset
@@ -39338,7 +39385,7 @@ status open
 \begin_layout Standard
 more than 10^13 is an estimate: on my Athlon 2800+ it takes about (0.5+6.5+20)
  minutes for (configure+make+regression test), and there is (i386, amd64,
- alpha, ppc64, (mingw32), sparc, macosx).
+ alpha, ppc64, (mingw32), sparc, Mac OS X).
  
 \end_layout