add documentation about existence of RAW1394DEV

git-svn-id: svn://svn.linux1394.org/libraw1394/trunk@171 53a565d1-3bb7-0310-b661-cf11e63c67ab

1 files changed, 12 insertions, 2 deletions

diff --git a/src/raw1394.h b/src/raw1394.h
index 751c153..a847938 100644
--- a/src/raw1394.h
+++ b/src/raw1394.h
@@ -398,9 +398,14 @@ int raw1394_errcode_to_errno(raw1394_errcode_t errcode);
  * processes.  It is allowed to create and use multiple handles, however.  Use
  * one handle per thread which needs it in the multithreaded case.
  *
+ * The default device node is /dev/raw1394, but one can override the default
+ * by setting environment variable RAW1394DEV. However, if RAW1394DEV points to
+ * a non-existant or invalid device node, then it also attempts to open the
+ * default device node.
+ *
  * Returns: the created handle or %NULL when initialization fails. In the latter
- * case errno either contains some OS specific error code or %0 if the error is
- * that libraw1394 and raw1394 don't support each other's protocol versions.
+ * case errno either contains some OS specific error code or EPROTO if
+ * libraw1394 and raw1394 don't support each other's protocol versions.
  **/
 raw1394handle_t raw1394_new_handle(void);
 
@@ -424,6 +429,11 @@ void raw1394_destroy_handle(raw1394handle_t handle);
  * command-line programs that already know what port they want. If
  * raw1394_set_port() returns ESTALE, retries automatically.
  *
+ * The default device node is /dev/raw1394, but one can override the default
+ * by setting environment variable RAW1394DEV. However, if RAW1394DEV points to
+ * a non-existant or invalid device node, then it also attempts to open the
+ * default device node.
+ *
  * Returns: the new handle on success or NULL on failure
  **/
 raw1394handle_t raw1394_new_handle_on_port(int port);