fly/flightgear
1
0
Fork 0
Code Activity

Update man pages.

Browse source 
Drop obsolete pages.
Add fgpanel and terrasync man pages.
This commit is contained in:
ThorstenB 2011-12-19 11:35:02 +01:00
parent f77c6b95fa
commit d696f805cf
9 changed files with 118 additions and 89 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
man/CMakeLists.txt
View file

@ -7,12 +7,12 @@ else(${CMAKE_VERSION} VERSION_GREATER 2.8.4)
endif(${CMAKE_VERSION} VERSION_GREATER 2.8.4)
set(MANPAGES
est-epsilon.1
fgfs.1
fgjs.1
fgpanel.1
gl-info.1
js_demo.1
pstest.1)
terrasync.1)
# map some variables to what the man-pages expect
set(PACKAGE ${CMAKE_PROJECT_NAME})
@ -23,8 +23,7 @@ foreach(man ${MANPAGES})
"${PROJECT_SOURCE_DIR}/man/${man}.in"
"${PROJECT_BINARY_DIR}/man/${man}"
)
install(FILES ${PROJECT_BINARY_DIR}/man/${man}
DESTINATION ${CMAKE_INSTALL_MANDIR}/man1 COMPONENT doc)
endforeach()

34
man/est-epsilon.1.in
View file

@ -1,34 +0,0 @@
.\" Copyright (C) 2002 Cameron Moore
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.Id $Id$
.TH EST-EPSILON 1 "January 2002" "@VERSION@" "@PACKAGE@"
.SH NAME
est-epsilon \- GLfloat epsilon estimation program for FlightGear
.SH SYNOPSIS
.B est-epsilon
.SH DESCRIPTION
.B est-epsilon
is an OpenGL test program used to show epsilon estimation of GLfloat.
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net>.
.SH SEE ALSO
fgfs(1)
.SH AUTHORS
Curt L. Olson, et al. See
.I Thanks
file for a list of contributors.

11
man/fgfs.1.in
View file

@ -12,11 +12,10 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.Id $Id$
.TH FGFS 1 "October 2003" "@VERSION@" "@PACKAGE@"
.TH FGFS 1 "February 2012" "@VERSION@" "@PACKAGE@"
.SH NAME
fgfs \- FlightGear Flight Simulator
.SH SYNOPSIS
@ -27,6 +26,7 @@ fgfs \- FlightGear Flight Simulator
is a free, open-source, multi-platform, and sophisticated flight
simulator framework for the development and pursuit of interesting
flight simulator ideas.
For more information visit <http://www.flightgear.org>.
.SH OPTIONS
.TP
.BI "--adf=" "[rotation:]frequency"
@ -509,9 +509,10 @@ $FG_ROOT/mice.xml
Mouse bindings.
.RE
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net>.
Send bug reports to <flightgear-devel@lists.sourceforge.net> or visit
<http://code.google.com/p/flightgear-bugs>.
.SH SEE ALSO
fgjs(1)
fgjs(1), fgpanel(1), js_demo(1), terrasync(1)
.SH AUTHORS
Curt L. Olson, et al. See
.I Thanks

9
man/fgjs.1.in
View file

@ -12,10 +12,9 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.Id $Id$
.TH FGJS 1 "January 2002" "@VERSION@" "@PACKAGE@"
.SH NAME
fgjs \- FlightGear Joystick Utility
@ -25,10 +24,12 @@ fgjs \- FlightGear Joystick Utility
.B fgjs
is a joystick utility for the FlightGear Flight Simulator. It allows
you to generate an appropriate configuration file for your joystick.
For more information visit <http://wiki.flightgear.org/Joystick>.
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net>.
Send bug reports to <flightgear-devel@lists.sourceforge.net> or visit
<http://code.google.com/p/flightgear-bugs>.
.SH SEE ALSO
fgfs(1)
fgfs(1), fgpanel(1), js_demo(1), terrasync(1)
.SH AUTHORS
Tony Peden, et al. See
.I Thanks

48
man/fgpanel.1.in Normal file
View file

@ -0,0 +1,48 @@
.\" Copyright (C) 2011 Thorsten Brehm
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or see here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH FGPANEL 1 "February 2012" "@VERSION@" "@PACKAGE@"
.SH NAME
fgpanel \- FlightGear Flight Simulator Panel Rendering Engine
.SH SYNOPSIS
.B "fgpanel "
[\-\-\fIfg-root\fP=path] [\-\-\fIprop\fP:name=value] \-\-\fIpanel\fP=file
.SH DESCRIPTION
.B FlightGear Panel
is a free, open-source, multi-platform, and lightweight panel rendering engine
to draw 2D panels on a low-cost computer/graphic card without 3D acceleration
at reasonable frame rates.
For more information visit <http://wiki.flightgear.org/FGPanel>.
.SH OPTIONS
.TP
.BI "--fg-root=" "path"
Specify the root path for data files.
.TP
.BI "--panel=" "file"
Specify the panel description file to be displayed.
.TP
.BI "--prop:" "name=value"
set property <name> to <value>.
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net> or visit
<http://code.google.com/p/flightgear-bugs>.
.SH SEE ALSO
fgfs(1), fgjs(1), js_demo(1), terrasync(1)
.SH AUTHORS
Torsten Dreyer, et al. See
.I Thanks
file for a list of contributors.

8
man/gl-info.1.in
View file

@ -12,10 +12,9 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.Id $Id$
.TH GL-INFO 1 "January 2002" "@VERSION@" "@PACKAGE@"
.SH NAME
gl-info \- OpenGL test program for FlightGear
@ -25,9 +24,10 @@ gl-info \- OpenGL test program for FlightGear
.B gl-info
is an OpenGL test program used to verify a valid OpenGL environment.
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net>.
Send bug reports to <flightgear-devel@lists.sourceforge.net> or visit
<http://code.google.com/p/flightgear-bugs>.
.SH SEE ALSO
fgfs(1)
fgfs(1), fgjs(1), fgpanel(1), js_demo(1), terrasync(1)
.SH AUTHORS
Curt L. Olson, et al. See
.I Thanks

9
man/js_demo.1.in
View file

@ -12,10 +12,9 @@
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.Id $Id$
.TH JS_DEMO 1 "January 2002" "@VERSION@" "@PACKAGE@"
.SH NAME
js_demo \- joystick test program for FlightGear
@ -24,10 +23,12 @@ js_demo \- joystick test program for FlightGear
.SH DESCRIPTION
.B js_demo
is a joystick test program for the FlightGear Flight Simulator.
For more information visit <http://wiki.flightgear.org/Joystick>.
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net>.
Send bug reports to <flightgear-devel@lists.sourceforge.net> or visit
<http://code.google.com/p/flightgear-bugs>.
.SH SEE ALSO
fgfs(1), fgjs(1)
fgfs(1), fgjs(1), fgpanel(1), terrasync(1)
.SH AUTHORS
Tony Peden, et al. See
.I Thanks

34
man/pstest.1.in
View file

@ -1,34 +0,0 @@
.\" Copyright (C) 2002 Cameron Moore
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
.\" Or try here: http://www.fsf.org/copyleft/gpl.html
.\"
.Id $Id$
.TH PSTEST 1 "January 2002" "@VERSION@" "@PACKAGE@"
.SH NAME
pstest \- engine model test for FlightGear
.SH SYNOPSIS
.B pstest
.SH DESCRIPTION
.B pstest
is a test program that models a Continental IO-520-M engine.
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net>.
.SH SEE ALSO
fgfs(1)
.SH AUTHORS
Curt L. Olson, et al. See
.I Thanks
file for a list of contributors.

47
man/terrasync.1.in Normal file
View file

@ -0,0 +1,47 @@
.\" Copyright (C) 2011 Thorsten Brehm
.\"
.\" This program is free software; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License
.\" as published by the Free Software Foundation; either version 2
.\" of the License, or (at your option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public License
.\" along with this program; if not, write to the Free Software
.\" Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
.\" Or see here: http://www.fsf.org/copyleft/gpl.html
.\"
.TH TERRASYNC 1 "February 2012" "@VERSION@" "@PACKAGE@"
.SH NAME
terrasync \- FlightGear Flight Simulator Terrain Synchronization
.SH SYNOPSIS
.B "terrasync "
[\-\fId\fP path] [\-\fIp\fP port] [\-\fIv\fP]
.SH DESCRIPTION
.B FlightGear TerraSync
is a utility that automatically downloads the newest version of the FlightGear
scenery while the simulator is running.
For more information visit <http://wiki.flightgear.org/TerraSync>.
.SH OPTIONS
.TP
.BI "-d" " path"
Specify the path where to store the scenery data.
.TP
.BI "-p" " port"
Specify the UDP port where terrasync listens for a FlightGear Flight Simulator connection.
.TP
.BI "-v"
Enable verbose output.
.SH BUGS
Send bug reports to <flightgear-devel@lists.sourceforge.net> or visit
<http://code.google.com/p/flightgear-bugs>.
.SH SEE ALSO
fgfs(1), fgjs(1), js_demo(1), terrasync(1)
.SH AUTHORS
Curt L. Olson, et al. See
.I Thanks
file for a list of contributors.