the manual contained wrong licence wording inconsistent with any other sources, inclu...

[wxWidgets.git] / docs / latex / wx / stdpaths.tex

diff --git a/docs/latex/wx/stdpaths.tex b/docs/latex/wx/stdpaths.tex
index f4f7ce4cf2bd7c78dfd8349667d88a09a43e0753..148dad71291664bb634e6868c2fb8695dade0e64 100644 (file)
--- a/docs/latex/wx/stdpaths.tex
+++ b/docs/latex/wx/stdpaths.tex
@@ -6,13 +6,13 @@
 %% Created:     2004-10-17
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>
 %% Created:     2004-10-17
 %% RCS-ID:      $Id$
 %% Copyright:   (c) 2004 Vadim Zeitlin <vadim@wxwindows.org>

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxStandardPaths}}\label{wxstandardpaths}
 
 wxStandardPaths returns the standard locations in the file system and should be
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxStandardPaths}}\label{wxstandardpaths}
 
 wxStandardPaths returns the standard locations in the file system and should be

-used by the programs to find their data files in a portable way.
+used by applications to find their data files in a portable way.

 
 Please note that this is not a real class because object of this type are never
 created but more a namespace containing the class methods which are all static,
 
 Please note that this is not a real class because object of this type are never
 created but more a namespace containing the class methods which are all static,


@@ -40,13 +40,16 @@ applications. I.e. under Unix you should follow the standard installation
 conventions and under Mac you should create your application bundle according
 to the Apple guidelines. Again, this class doesn't help you to do it.
 
 conventions and under Mac you should create your application bundle according
 to the Apple guidelines. Again, this class doesn't help you to do it.
 

+This class is MT-safe: its methods may be called concurrently from different
+threads without additional locking.
+

 \wxheading{Derived from}
 
 No base class
 
 \wxheading{Include files}
 
 \wxheading{Derived from}
 
 No base class
 
 \wxheading{Include files}
 

-<wx/fileloc.h>
+<wx/stdpaths.h>

 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}


@@ -61,7 +64,7 @@ Return the directory containing the system config files.
 Example return values:
 \begin{itemize}
     \item Unix: \texttt{/etc}
 Example return values:
 \begin{itemize}
     \item Unix: \texttt{/etc}

-    \item Windows: \texttt{C:$\backslash$Windows}
+    \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$All Users$\backslash$Application Data}

     \item Mac: \texttt{/Library/Preferences}
 \end{itemize}
 
     \item Mac: \texttt{/Library/Preferences}
 \end{itemize}
 


@@ -80,7 +83,7 @@ data files.
 Example return values:
 \begin{itemize}
     \item Unix: \texttt{\textit{prefix}/share/\textit{appname}}
 Example return values:
 \begin{itemize}
     \item Unix: \texttt{\textit{prefix}/share/\textit{appname}}

-    \item Windows: \texttt{C:$\backslash$Program Files$\backslash$\textit{appname}}
+    \item Windows: the directory where the executable file is located

     \item Mac: \texttt{\textit{appname}.app/Contents/SharedSupport} bundle subdirectory
 \end{itemize}
 
     \item Mac: \texttt{\textit{appname}.app/Contents/SharedSupport} bundle subdirectory
 \end{itemize}
 


@@ -139,9 +142,9 @@ Example return values:
 
 Return the directory for the user config files:
 \begin{itemize}
 
 Return the directory for the user config files:
 \begin{itemize}

-    \item Unix: \texttt{\verb|~|} (the home directory)
-    \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}}
-    \item Mac: \texttt{\verb|~|/Library/Preferences}
+    \item Unix: \tt{~} (the home directory)
+    \item Windows: \tt{C:$\backslash$Documents and Settings$\backslash$\textit{username}}
+    \item Mac: \tt{~/Library/Preferences}

 \end{itemize}
 
 Only use this method if you have a single configuration file to put in this
 \end{itemize}
 
 Only use this method if you have a single configuration file to put in this


@@ -155,9 +158,9 @@ more appropriate.
 
 Return the directory for the user-dependent application data files:
 \begin{itemize}
 
 Return the directory for the user-dependent application data files:
 \begin{itemize}

-    \item Unix: \texttt{\verb|~|/.\textit{appname}}
-    \item Windows: \texttt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Application Data$\backslash$\textit{appname}}
-    \item Mac: \texttt{\verb|~|/Library/Application Support/\textit{appname}}
+    \item Unix: \tt{~/.\textit{appname}}
+    \item Windows: \tt{C:$\backslash$Documents and Settings$\backslash$\textit{username}$\backslash$Application Data$\backslash$\textit{appname}}
+    \item Mac: \tt{~/Library/Application Support/\textit{appname}}

 \end{itemize}
 
 
 \end{itemize}
 
 


@@ -177,7 +180,7 @@ all platforms except Windows where it returns
 
 \func{static void}{SetInstallPrefix}{\param{const wxString\& }{prefix}}
 
 
 \func{static void}{SetInstallPrefix}{\param{const wxString\& }{prefix}}
 

-\textbf{Note: } This function is only available under Unix.
+\textbf{Note:} This function is only available under Unix.

 
 Lets wxStandardPaths know about the real program installation prefix on a Unix
 system. By default, the value returned by 
 
 Lets wxStandardPaths know about the real program installation prefix on a Unix
 system. By default, the value returned by