summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEvan Nemerson <evan@coeus-group.com>2010-04-14 00:33:12 -0700
committerJürg Billeter <j@bitron.ch>2010-05-27 23:01:18 +0200
commit164faf62442d41b4a688689bb718f4c0be3705bd (patch)
tree7957827d7867c5223889b6db63008ee5770f404e /doc
parentc3885bf7e7db0720fa884618e5d8f60ce3a6ef9d (diff)
downloadvala-164faf62442d41b4a688689bb718f4c0be3705bd.tar.gz
Update documentation
Fixes bug 615710.
Diffstat (limited to 'doc')
-rw-r--r--doc/building.txt2
-rw-r--r--doc/valac.1100
-rw-r--r--doc/vapigen.124
3 files changed, 97 insertions, 29 deletions
diff --git a/doc/building.txt b/doc/building.txt
index a4a7a89d0..ad205ebea 100644
--- a/doc/building.txt
+++ b/doc/building.txt
@@ -30,7 +30,7 @@ Step four:
Compiling the newest Vala from the repository:
-svn co svn co svn+ssh://[user]@svn.gnome.org/svn/vala/trunk vala
+git clone git://git.gnome.org/vala
cd vala
export VALAC=/opt/vala-release/bin/vala
./autogen.sh --prefix=/opt/vala
diff --git a/doc/valac.1 b/doc/valac.1
index f1ee93b6c..5ee2556aa 100644
--- a/doc/valac.1
+++ b/doc/valac.1
@@ -1,9 +1,9 @@
-.TH "valac" 1
+.TH valac 1 "13 April 2010" "vala-0.8.0" "Vala"
.SH NAME
valac \- compiler that translates Vala source code into C source and header files
.SH SYNOPSIS
.B valac
-[OPTION...] FILE...
+[\fIOPTION\fR]... [\fIFILE\fR]...
.SH DESCRIPTION
Vala is a new programming language that aims to bring modern
programming language features to GNOME developers without imposing any
@@ -17,34 +17,60 @@ source code.
.SH OPTIONS
.TP
.B \--help
-Show help options
.TP
-.B \--vapidir=DIRECTORY...
-Look for package bindings in DIRECTORY
+.B \--girdir=\fIDIRECTORY\fR...
+Look for .gir files in \fIDIRECTORY\fR
.TP
-.B \--pkg=PACKAGE...
-Include binding for PACKAGE
+.B \--vapidir=\fIDIRECTORY\fR...
+Look for package bindings in \fIDIRECTORY\fR
.TP
-.B \--library=NAME
+.B \--pkg=\fIPACKAGE\fR...
+Include binding for \fIPACKAGE\fR
+.TP
+.B \--vapi=\fIFILE\fR
+Output VAPI file name
+.TP
+.B \--library=\fINAME\fR
Library name
.TP
-.B \-d, --directory=DIRECTORY
+.B \--gir=\fINAME\fR-\fIVERSION\fR.gir
+GObject-Introspection repository file name
+.TP
+.B \-b, --basedir=\fIDIRECTORY\fR
+Base source directory
+.TP
+.B \-d, --directory=\fIDIRECTORY\fR
Output directory
.TP
-.B \--version
+.B \--version
Display version number
.TP
.B \-C, --ccode
Output C code
.TP
-.B \-H, --header=FILE
+.B \-H, --header=\fIFILE\fR
Output C header file
.TP
+.B \--use-header
+Use C header file
+.TP
+.B \--includedir=\fIDIRECTORY\fR
+Directory used to include the C header file
+.TP
+.B \-h, --internal-header=\fIFILE\fR
+Output internal C header file
+.TP
+.B \--internal-vapi=\fIFILE\fR
+Output vapi with internal api
+.TP
+.B \--symbols=\fIFILE\fR
+Output symbols file
+.TP
.B \-c, --compile
Compile but do not link
.TP
-.B \-o, --output=FILE
-Place output in file FILE
+.B \-o, --output=\fIFILE\fR
+Place output in file \fIFILE\fR
.TP
.B \-g, --debug
Produce debug information
@@ -52,9 +78,18 @@ Produce debug information
.B \--thread
Enable multithreading support
.TP
+.B \--enable-mem-profiler
+Enable GLib memory profiler
+.TP
.B \-D, --define=SYMBOL...
Define SYMBOL
.TP
+.B \--main=SYMBOL...
+Use SYMBOL as entry point
+.TP
+.B \--nostdpkg
+Do not include standard packages
+.TP
.B \--disable-assert
Disable assertions
.TP
@@ -67,17 +102,44 @@ Enable deprecated features
.B \--enable-experimental
Enable experimental features
.TP
-.B \--cc=COMMAND
-Use COMMAND as C compiler command
+.B \--disable-warnings
+Disable warnings
+.TP
+.B \--enable-experimental-non-null
+Enable experimental enhancements for non-null types
+.TP
+.B \--disable-dbus-transformation
+Disable transformation of D-Bus member names
+.TP
+.B \--cc=\fICOMMAND\fR
+Use \fICOMMAND\fR as C compiler command
+.TP
+.B \-X, --Xcc=\fIOPTION\fR...
+Pass \fIOPTION\fR. to the C compiler
.TP
-.B \-X, --Xcc=OPTION...
-Pass OPTION to the C compiler
+.B \--dump-tree=\fIFILE\fR
+Write code tree to \fIFILE\fR
+.TP
+.B \--save-temps
+Keep temporary files
+.TP
+.B \--profile=\fIPROFILE\fR
+Use the given profile instead of the default
.TP
.B \-q, --quiet
Do not print messages to the console
.TP
-.B \--target-glib=MAJOR.MINOR
+.B \-v, --verbose
+Print additional messages to the console
+.TP
+.B \--target-glib=\fIMAJOR\fR.\fIMINOR\fR
Target version of glib for code generation
+.TP
+.B \--enable-version-header
+Write vala build version in generated files
+.TP
+.B \--disable-version-header
+Do not write vala build version in generated files
.SH FEATURES
Interfaces, properties, signals, foreach, lambda expressions, type
inference for local variables, generics, non-null types, assisted memory
@@ -85,7 +147,7 @@ management, exception handling
.SH HOMEPAGE AND BUG REPORT
http://www.vala-project.org/
.SH AUTHORS
-Jurg Billeter, Raffaele Sandrini.
+Jürg Billeter, Raffaele Sandrini.
Man page written to conform with Debian by Marc-Andre Lureau.
diff --git a/doc/vapigen.1 b/doc/vapigen.1
index 325c53e60..c1663414d 100644
--- a/doc/vapigen.1
+++ b/doc/vapigen.1
@@ -1,4 +1,4 @@
-.TH vapigen 1 "26 October 2007" "vala-0.1.5" "Vala"
+.TH vapigen 1 "13 April 2010" "vala-0.8.0" "Vala"
.IX vapigen
.SH NAME
vapigen \- generate a Vala API
@@ -20,29 +20,35 @@ This can then be converted to a Vala API as follows:
.SH OPTIONS
.TP
-\-?, \-\-help
+.B \-?, --help
Show help option
.TP
---vapidir=\fIDIRECTORY\fP
+.B \--vapidir=\fIDIRECTORY\fP
Look for package bindings in \fIDIRECTORY\fP.
.TP
---pkg=\fIPACKAGE\fP
-Include binding for PACKAGE
+.B \--pkg=\fIPACKAGE\fP
+Include binding for \fIPACKAGE\fP
.TP
---library=\fINAME\fP
+.B \--library=\fINAME\fP
Specify library name as \fINAME\fP
.TP
-\-d, \-\-directory=\fIDIRECTORY\fP
+.B \-d, --directory=\fIDIRECTORY\fP
Specify output directory as \fIDIRECTORY\fP
.TP
-\-\-version
+.B \--version
Display version number and exit.
+.TP
+.B \-q, --quiet
+Do not print messages to the console
.SH SEE ALSO
.BR vala-gen-introspect (1)
+.SH HOMEPAGE AND BUG REPORT
+http://www.vala-project.org/
+
.SH AUTHOR
-vapigen for Vala was written by Juerg Billeter <j@bitron.ch> and
+vapigen for Vala was written by Jürg Billeter <j@bitron.ch> and
Raffaele Sandrini <rasa@gmx.ch>.
.PP
This manual page was written by Kumar Appaiah <akumar@ee.iitm.ac.in>,