Skip to content

Commit dd4e72b

Browse files
committed
wrote the README file, changed dates in copyright statements to reflect the new release dates.
git-svn-id: svn+ssh://svn.code.sf.net/p/spacenav/code/trunk/libspnav@65 ef983eb1-d774-4af8-acfd-baaf7b16a646
1 parent 0e7c359 commit dd4e72b

6 files changed

Lines changed: 59 additions & 15 deletions

File tree

README

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,47 @@
1-
to be written...
1+
1. About the libspnav library
2+
3+
The libspnav library is provided as a replacement of the magellan library. It
4+
provides a cleaner, and more orthogonal interface. libspnav supports both the
5+
original X11 protocol for communicating with the driver, and the new
6+
alternative non-X protocol. Programs that choose to use the X11 protocol, are
7+
automatically compatible with either the free spacenavd driver or the official
8+
3dxserv, as if they were using the magellan SDK.
9+
10+
Also, libspnav provides a magellan API wrapper on top of the new API. So, any
11+
applications that were using the magellan library, can switch to libspnav
12+
without any changes. And programmers that are familliar with the magellan API
13+
can continue using it with a free library without the restrictions of the
14+
official SDK.
15+
16+
17+
2. Installation
18+
19+
Configure, make, and make install as usual.
20+
21+
22+
3. License
23+
24+
libspnav is part of the spacenav project (spacenav.sf.net)
25+
Copyright (C) 2007-2009 John Tsiombikas <nuclear@member.fsf.org>
26+
27+
Redistribution and use in source and binary forms, with or without
28+
modification, are permitted provided that the following conditions are met:
29+
30+
1. Redistributions of source code must retain the above copyright notice, this
31+
list of conditions and the following disclaimer.
32+
2. Redistributions in binary form must reproduce the above copyright notice,
33+
this list of conditions and the following disclaimer in the documentation
34+
and/or other materials provided with the distribution.
35+
3. The name of the author may not be used to endorse or promote products
36+
derived from this software without specific prior written permission.
37+
38+
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
39+
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
40+
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
41+
EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
42+
EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
43+
OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
44+
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
45+
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
46+
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
47+
OF SUCH DAMAGE.

examples/Makefile

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,14 @@ CC = gcc
22
CFLAGS = -pedantic -Wall -g -I..
33
LDFLAGS = -L.. -lspnav -lX11
44

5-
all: simple_x11 simple_af_unix
5+
.PHONY: all
6+
all: simple_x11 simple_af_unix
67

7-
simple_x11: simple.c
8-
$(CC) $(CFLAGS) $(LDFLAGS) -DBUILD_X11 -o $@ $^
9-
simple_af_unix: simple.c
10-
$(CC) $(CFLAGS) $(LDFLAGS) -DBUILD_AF_UNIX -o $@ $^
8+
simple_x11: simple.c
9+
$(CC) $(CFLAGS) -DBUILD_X11 -o $@ $< $(LDFLAGS)
10+
simple_af_unix: simple.c
11+
$(CC) $(CFLAGS) -DBUILD_AF_UNIX -o $@ $< $(LDFLAGS)
1112

1213
.PHONY: clean
1314
clean:
14-
rm -f simple_x11 simple_x11.o \
15-
simple_af_unix simple_af_unix.o
16-
15+
rm -f simple_x11 simple_af_unix

spnav.c

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
This file is part of libspnav, part of the spacenav project (spacenav.sf.net)
3-
Copyright (C) 2007 John Tsiombikas <nuclear@siggraph.org>
3+
Copyright (C) 2007-2009 John Tsiombikas <nuclear@siggraph.org>
44
55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:
@@ -36,7 +36,7 @@ OF SUCH DAMAGE.
3636
#include <sys/select.h>
3737
#include "spnav.h"
3838

39-
#define SPNAV_SOCK_PATH "/tmp/.spnav.sock"
39+
#define SPNAV_SOCK_PATH "/var/run/spnav.sock"
4040

4141
#ifdef USE_X11
4242
#include <X11/Xlib.h>
@@ -54,7 +54,6 @@ enum {
5454
CMD_APP_SENS
5555
};
5656

57-
/* TODO: note: 0 is a valid socket fd, -1 isn't */
5857
#define IS_OPEN (dpy || (sock != -1))
5958
#else
6059
#define IS_OPEN (sock != -1)

spnav.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
This file is part of libspnav, part of the spacenav project (spacenav.sf.net)
3-
Copyright (C) 2007 John Tsiombikas <nuclear@siggraph.org>
3+
Copyright (C) 2007-2009 John Tsiombikas <nuclear@siggraph.org>
44
55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:

spnav_magellan.c

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
This file is part of libspnav, part of the spacenav project (spacenav.sf.net)
3-
Copyright (C) 2007 John Tsiombikas <nuclear@siggraph.org>
3+
Copyright (C) 2007-2009 John Tsiombikas <nuclear@siggraph.org>
44
55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:

spnav_magellan.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
/*
22
This file is part of libspnav, part of the spacenav project (spacenav.sf.net)
3-
Copyright (C) 2007 John Tsiombikas <nuclear@siggraph.org>
3+
Copyright (C) 2007-2009 John Tsiombikas <nuclear@siggraph.org>
44
55
Redistribution and use in source and binary forms, with or without
66
modification, are permitted provided that the following conditions are met:

0 commit comments

Comments
 (0)