Commit Graph

60 Commits

Author SHA1 Message Date
Matteo Cypriani 913a62377e Improve README.md 2016-11-05 00:22:41 -04:00
Matteo Cypriani 550d9008db [doc] preproc.sh: fix for BSD sed 2016-11-03 22:08:06 -04:00
Matteo Cypriani 2c9f1a09b0 [doc] Add rendered pictures (PNG) 2016-11-03 22:06:17 -04:00
Matteo Cypriani 4d309d9c10 [doc] Add figures/Makefile 2016-11-03 22:06:17 -04:00
Matteo Cypriani 36966148f3 [doc] Add positioner_class_diagram_simple.plant
This is a simplified, and somewhat more readable version of
positioner_class_diagram.uxf.
2016-11-03 22:05:55 -04:00
Matteo Cypriani 759db45a50 A few old cosmetic changes 2016-11-03 22:00:33 -04:00
Matteo Cypriani bc6ec14fa8 Update COPYRIGHT.t2t URL 2016-11-03 22:00:33 -04:00
Matteo Cypriani fbef235ebf [doc] Update URLs
OwlPS is now hosted on a Gogs instance, that replaced the defunct
InDefero.
2016-11-03 21:57:53 -04:00
Matteo Cypriani a567782557 [doc] Some rewording 2016-11-03 00:46:37 -04:00
Matteo Cypriani dc64f050a8 [doc] Quit using "CP" where not necessary 2014-10-31 11:36:34 -04:00
Matteo Cypriani 7d84e7c957 [doc] positionerd: add filter options
Also add default value explanation in owlps-positioner.conf.
2014-10-31 11:36:34 -04:00
Matteo Cypriani e4b8e7239b Update Doxygen files (Doxyfile) to 1.8.8 2014-10-31 11:18:15 -04:00
Matteo Cypriani 209530ad41 [doc] CMake: use current date if not using Git
If not building against the source from the Git repository, the date
can't be retrieved with Git; in that case we use the current date in the
documentation.
2014-07-25 15:15:48 -04:00
Matteo Cypriani 4d78da4721 Doc and comments: some typos & small additions 2014-02-18 10:22:35 -05:00
Matteo Cypriani 8692a1ba9b [doc] aggregatord: add ASCII art sequence diagram 2013-10-03 12:26:01 -04:00
Matteo Cypriani 3a14fa17e9 [doc] Additional figures
Add three figures ad well as a text file that lists them.
2013-10-03 11:54:01 -04:00
Matteo Cypriani 191521751b [doc] architecture: add process diagram 2013-10-03 09:49:34 -04:00
Matteo Cypriani 0b2835c744 [doc] Add owlps-positionerd.t2t 2013-10-01 13:54:20 -04:00
Matteo Cypriani d4cd2e6a63 [doc] CMake: install man pages 2013-09-23 17:03:51 -04:00
Matteo Cypriani e5883d99d5 Finish supporting getaddrinfo()
- For static buffers, use a size suited for host names and not only IP
  addresses.
- Change variable names.
- Adapt usage messages and documentation.
2013-09-23 17:03:51 -04:00
Matteo Cypriani e58d158286 [Client] Change -F option's behaviour
In flood mode, the delay is now counted from the beginning of the
transmission of a request, instead of after the end of the transmission.
The old behaviour is still supported by adding a '+' before the delay
duration on the command line.
2013-09-23 16:10:54 -04:00
Matteo Cypriani f10f99634c [doc] Cosmetic improvements
"Options" comes right after "Description", quotes, etc.
2013-09-23 16:10:53 -04:00
Matteo Cypriani c10b9de1b4 [doc] aggregator and listener: add Files section 2013-09-23 16:10:53 -04:00
Matteo Cypriani 9d02312603 [doc] preproc: translate {{INSTALL_PREFIX}}
preproc.sh now translates the {{INSTALL_PREFIX}} string as well as the
{{OWLPS_VERSION}} string. Both values are now obtained from the
corresponding environment variables (OWLPS_VERSION was previously
obtained through a special git command).
2013-09-23 16:10:53 -04:00
Matteo Cypriani c48ee0c555 [UDP-HTTP] "NoResults" instead of "NoResult"
Set the explanation to "NoResults" when a request is received but no
results were read yet.
2013-09-23 16:10:53 -04:00
Matteo Cypriani 5435fd8e68 [doc] Add owlps-udp-to-http.t2t 2013-09-23 16:10:53 -04:00
Matteo Cypriani f181087d70 [doc] CMake: handle dependencies for doc_doxygen
The doc_doxygen target now depends on the C input files.
2013-09-23 16:10:53 -04:00
Matteo Cypriani efaf4da6ed [doc] Somewhat improve Doxygen-generated man pages
Fix some problems in the Doxygen-generated man pages (C libraries), the
more noticeable being removing the full path of the files from the
header and synopsis.
2013-09-23 16:10:53 -04:00
Matteo Cypriani b126cdc98d [doc] CMake: Perl modules' man pages go to man3
The manual pages of Perl modules now go to the man3/ directory instead
of a separate man3perl/ directory.
2013-09-23 16:10:52 -04:00
Matteo Cypriani 3edf06337c [doc] CMake: rename Perl modules' man pages (::)
Perl modules' man pages should be named Foo::Bar.3perl instead of
Foo--Bar.3perl. This is fixed but the solution is incomplete and hacky,
due to a limitation of make: Foo--Bar.3perl is first generated, then
renamed to Foo::Bar.3perl. This breaks the dependencies and
Foo--Bar.3perl will be re-generated at each run of make.
2013-09-23 16:10:52 -04:00
Matteo Cypriani 810d02d5b8 [doc] CMake: more portable clean_doxygen_garbage
Use cmake -E remove instead of rm -f.
2013-09-23 16:10:52 -04:00
Matteo Cypriani c3896662fd [doc] CMake: force order of Doxygen targets
Make sure the doxygen garbage is cleaned after being generated.
2013-09-23 16:10:52 -04:00
Matteo Cypriani cc121f382e [doc] CMake: generate man pages from Perl files
Generate manual pages from the Perl programs and modules in the scripts/
directory, thanks to pod2man.
2013-09-23 16:10:52 -04:00
Matteo Cypriani c169bcb5d2 [doc] CMake: don't quit if txt2tags is not found
Don't return if txt2tags is not found, so that Doxygen-generated man
pages can be built.
2013-09-23 16:10:52 -04:00
Matteo Cypriani 386c279f6c [doc] aggregatord: add section CSV format 2013-09-23 16:10:52 -04:00
Matteo Cypriani 89cf84403c [doc] listenerd: add links in the description 2013-09-23 16:10:52 -04:00
Matteo Cypriani 73b71f279d [doc] Add owlps-aggregatord.t2t 2013-09-23 16:10:52 -04:00
Matteo Cypriani a8cb529b2c [doc] Add Positioner's class diagram
Add the figure positioner_class_diagram.uxf, created with Umlet
(http://umlet.com/).
2013-07-26 16:48:54 -04:00
Matteo Cypriani b227bb17b5 [doc] Change format of links to other manpages
Links to other manual pages are now in italic, to match the links
generated by pod.
2013-07-25 19:11:03 -04:00
Matteo Cypriani c50ac30ba4 Update Doxyfiles to Doxygen 1.8.4 format 2013-07-17 18:09:15 -04:00
Matteo Cypriani b930333fbb [doc] client: a couple of minor improvements 2013-07-17 18:09:15 -04:00
Matteo Cypriani a6c9c12a30 [doc] Add owlps-listenerd.t2t 2013-07-17 18:09:14 -04:00
Matteo Cypriani 779c859add [doc] owlps: add Cross-version compatibility note 2013-07-17 18:09:14 -04:00
Matteo Cypriani a18a38c7ee [doc] architecture: add Autocalibration section 2013-07-17 18:09:14 -04:00
Matteo Cypriani 5d7c68fe2f [doc] Add owlps-deployment.t2t 2013-07-17 18:09:14 -04:00
Matteo Cypriani f4980d003e [doc] Add copyright notices in man pages 2013-07-17 18:09:14 -04:00
Matteo Cypriani 6c1c182039 [Listener] Adapt get_mac_addr() to build on BSD
The get_mac_addr() function was the only real blocker that prevented
building on BSD systems, as it used the Linux-specific SIOCGIFHWADDR
ioctl. When compiling for Linux, we still use this ioctl, but for the
BSD version we use sysctl().

This allows OwlPS Listener to build on BSD (tested on NetBSD, OpenBSD
and DragonFly). That doesn't mean it will actually work when trying to
capture packets though (that has to be tested on real hardware), but
that's still a progress.
2013-07-17 18:09:12 -04:00
Matteo Cypriani 86510d490f [doc] owlps.t2t: update main description 2013-06-12 12:34:36 -04:00
Matteo Cypriani 35eef92e94 [doc] Fix links to commands' manuals 2013-06-12 12:32:12 -04:00
Matteo Cypriani 6551bd6c3a [doc] Finish writing owlps-client.t2t 2013-06-12 09:38:38 -04:00