summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHans Ulrich Niedermann <gp@n-dimensional.de>2006-08-16 21:27:45 +0000
committerHans Ulrich Niedermann <gp@n-dimensional.de>2006-08-16 21:27:45 +0000
commit204bea94d2679581bf73e141fa7032fab4b32e98 (patch)
treeb5824691e5b6f6ecd23bb0f3955ea3a2e39b2d72 /doc
parent9e65e66c90034e36de572cb285126afb8b3e3763 (diff)
downloadlibgphoto2-204bea94d2679581bf73e141fa7032fab4b32e98.tar.gz
update man pages from gphoto2-manual
git-svn-id: https://svn.code.sf.net/p/gphoto/code/trunk/libgphoto2@9086 67ed7778-7388-44ab-90cf-0a291f65f57c
Diffstat (limited to 'doc')
-rw-r--r--doc/libgphoto2.3110
-rw-r--r--doc/libgphoto2_port.3109
2 files changed, 130 insertions, 89 deletions
diff --git a/doc/libgphoto2.3 b/doc/libgphoto2.3
index d6aa14b38..ccb4ec581 100644
--- a/doc/libgphoto2.3
+++ b/doc/libgphoto2.3
@@ -1,57 +1,79 @@
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "LIBGPHOTO2" 3 "" "" ""
-.SH NAME
-libgphoto2 \- cross-platform digital camera library
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "LIBGPHOTO2" "3" "08/16/2006" "" "The gPhoto2 Reference (the man"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+libgphoto2 \- cross\-platform digital camera library
.SH "SYNOPSIS"
-
+.sp
.nf
-#include <gphoto2\&.h>
+#include <gphoto2.h>
.fi
-
.SH "DESCRIPTION"
-
.PP
-The gphoto2 library provides applications with access to a variety of cameras\&.
-
+The
+gphoto2
+library provides applications with access to a variety of cameras.
.PP
-This man page will be extended with autogenerated documentation of the interface types and methods used for communication between the gphoto2 library and a frontend\&.
-
+This man page will be extended with autogenerated documentation of the interface types and methods used for communication between the
+gphoto2
+library and a frontend.
.SH "FILES"
-
.TP
-\fI~/\&.gphoto/settings\fR
-Here gphoto2 applications may store their configuration used to access gphoto2\&.
-
+\fI~/.gphoto/settings\fR
+Here
+gphoto2
+applications may store their configuration used to access
+gphoto2.
+.PP
+To track down errors, you can add the
+\fB\-\-debug\fR
+parameter to the
+\fBgphoto2\fR
+command line and, if dealing with USB problems, setting the environment variable
+\fBUSB_DEBUG\fR\fI=1\fR.
.SH "ENVIRONMENT VARIABLES"
-
.TP
-CAMLIBS
-If set, defines the directory where libgphoto2 looks for its camera drivers (camlibs)\&.
-
+\fBCAMLIBS\fR
+If set, defines the directory where the
+libgphoto2
+library looks for its camera drivers (camlibs). You only need to set this on OS/2 systems and broken/test installations.
+.TP
+\fBIOLIBS\fR
+If set, defines the directory where the
+libgphoto2_port
+library looks for its I/O drivers (iolibs). You only need to set this on OS/2 systems and broken/test installations.
+.TP
+\fBLD_DEBUG\fR
+Set this to
+\fIall\fR
+to receive lots of debug information regarding library loading on
+\fBld\fR
+based systems.
+.TP
+\fBUSB_DEBUG\fR
+If set, defines the numeric debug level with which the
+libusb
+library will print messages. In order to get some debug output, set it to
+\fI1\fR.
.SH "SEE ALSO"
-
.PP
-\fBgphoto2\fR(1), \fBlibgphoto2_port\fR(3), The gPhoto2 Manual, automatically generated API docs, gphoto website: \fIhttp://www.gphoto.org/\fR \&.
-
-.SH AUTHOR
-The gPhoto2 Team.
+gphoto2(1),
+libgphoto2_port(3), The gPhoto2 Manual, automatically generated
+API
+docs,
+[1]\&\fIgphoto website\fR
+.
+.SH "AUTHOR"
+The gPhoto2 Team.
.br
-Man page edited by Hans Ulrich Niedermann[ gp at n minus dimensional dot de ].
+Hans Ulrich Niedermann <gp@n\-dimensional.de>. (man page)
+.SH "REFERENCES"
+.TP 3
+1.\ gphoto website
+\%http://www.gphoto.org/
diff --git a/doc/libgphoto2_port.3 b/doc/libgphoto2_port.3
index 94a17efb4..9c4758f4c 100644
--- a/doc/libgphoto2_port.3
+++ b/doc/libgphoto2_port.3
@@ -1,58 +1,77 @@
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "LIBGPHOTO2_PORT" 3 "" "" ""
-.SH NAME
-libgphoto2_port \- cross-platform port access library
+.\" ** You probably do not want to edit this file directly **
+.\" It was generated using the DocBook XSL Stylesheets (version 1.69.1).
+.\" Instead of manually editing it, you probably should edit the DocBook XML
+.\" source for it and then use the DocBook XSL Stylesheets to regenerate it.
+.TH "LIBGPHOTO2_PORT" "3" "08/16/2006" "" "The gPhoto2 Reference (the man"
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.SH "NAME"
+libgphoto2_port \- cross\-platform port access library
.SH "SYNOPSIS"
-
+.sp
.nf
-#include <gphoto2_port\&.h>
+#include <gphoto2_port.h>
.fi
-
.SH "DESCRIPTION"
-
.PP
-The libgphoto2_port library was written to provide \fBlibgphoto2\fR(3) with a generic way of accessing ports\&. In this function, libgphoto2_port is the successor of the libgpio library\&.
-
+The
+libgphoto2_port
+library was written to provide
+libgphoto2(3)
+with a generic way of accessing ports. In this function,
+libgphoto2_port
+is the successor of the
+libgpio
+library.
.PP
-Currently, libgphoto2_port supports serial (RS\-232) and USB connections, the latter requiring libusb to be installed\&.
-
+Currently,
+libgphoto2_port
+supports serial (RS\-232) and
+USB
+connections, the latter requiring
+libusb
+to be installed.
.PP
-The autogenerated API docs will be added here in the future\&.
-
+The autogenerated
+API
+docs will be added here in the future.
.SH "ENVIRONMENT VARIABLES"
-
.TP
-IOLIBS
-If set, defines the directory where libgphoto2_port looks for its I/O drivers (camlibs)\&.
-
+\fBIOLIBS\fR
+If set, defines the directory where the
+libgphoto2_port
+library looks for its I/O drivers (iolibs). You only need to set this on OS/2 systems and broken/test installations.
+.TP
+\fBLD_DEBUG\fR
+Set this to
+\fIall\fR
+to receive lots of debug information regarding library loading on
+\fBld\fR
+based systems.
.TP
-USB_DEBUG
-If set, defines the numeric libusb debug level with which libusb will print messages\&.
-
+\fBUSB_DEBUG\fR
+If set, defines the numeric debug level with which the
+libusb
+library will print messages. In order to get some debug output, set it to
+\fI1\fR.
.SH "SEE ALSO"
-
.PP
-\fBlibgphoto2\fR(3), The gPhoto2 Manual, gphoto website: \fIhttp://www.gphoto.org/\fR, automatically generated API docs, libusb website: \fIhttp://libusb.sourceforge.net/\fR \&.
-
-.SH AUTHOR
-The gPhoto2 Team.
+libgphoto2(3), The gPhoto2 Manual,
+[1]\&\fIgphoto website\fR, automatically generated
+API
+docs,
+[2]\&\fIlibusb website\fR
+.
+.SH "AUTHOR"
+The gPhoto2 Team.
.br
-Man page edited by Hans Ulrich Niedermann[ gp at n minus dimensional dot de ].
+Hans Ulrich Niedermann <gp@n\-dimensional.de>. (man page)
+.SH "REFERENCES"
+.TP 3
+1.\ gphoto website
+\%http://www.gphoto.org/
+.TP 3
+2.\ libusb website
+\%http://libusb.sourceforge.net/