aboutsummaryrefslogtreecommitdiffstats
path: root/doc
AgeCommit message (Collapse)AuthorFilesLines
2014-03-28Update README.wslua with latest info.Hadriel Kaplan1-56/+135
Change-Id: I20ea6c374f791054f16f0aaba33967b869348ff5 Reviewed-on: https://code.wireshark.org/review/857 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-03-19Add read_format extension to manual pagesHadriel Kaplan2-2/+9
The -X read_format extension was added in code but in the manuals. Change-Id: I21692120229ef531671fc3db247809ace69d23b3 Reviewed-on: https://code.wireshark.org/review/742 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-03-16Remove Visual Studio solution and project files (and their existence from ↵Michael Mann2-190/+0
Makefiles) There have been discussions on -dev about removing this and I believe I was the last holdout. Finally convinced that I should just have a local copy (ignored by git) Change-Id: Ic72a22baf58e3412023cf851f0fce16eb07113b0 Reviewed-on: https://code.wireshark.org/review/681 Reviewed-by: Michael Mann <mmann78@netscape.net> Reviewed-by: Evan Huus <eapache@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-15Fix README.heuristic wording to Bill Meier's correctionHadriel Kaplan1-2/+4
Change-Id: Ifeb61abdcc7aa049529d584ff3fe50b6fd79fe21 Reviewed-on: https://code.wireshark.org/review/662 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-14Add Lua heuristic dissector supportHadriel Kaplan1-4/+6
This adds the ability for Lua scripts to register heuristic dissectors for any protocol that has registered a heuristic dissector list, such as UDP, TCP, and ~50 others. The Lua function can also establish a conversation tied to its Proto dissector, to avoid having to check the heuristics for the same flow. The example dissector in the testsuite has also been enhanced to include a heuristic dissector, to verify the functionality and provide an example implementation. Change-Id: Ie232602779f43d3418fe8db09c61d5fc0b59597a Reviewed-on: https://code.wireshark.org/review/576 Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-03-13Note that a dissector heuristic test *must not* cause an exception before ↵Bill Meier1-0/+10
returning FALSE. Change-Id: I9f1ab000f7a2c554d1c20abf8ca4e4bab4b5ef27 Reviewed-on: https://code.wireshark.org/review/635 Reviewed-by: Bill Meier <wmeier@newsguy.com> Tested-by: Bill Meier <wmeier@newsguy.com>
2014-03-09Update documentation about p_[add|get]_proto_data (new argument: scope)Michael Mann1-5/+11
Change-Id: Ic27b0e601967c90567fac58447d28b10c02a3888 Reviewed-on: https://code.wireshark.org/review/564 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Anders Broman <a.broman58@gmail.com>
2014-02-26Fix some wmem-related documentation.Evan Huus2-11/+18
Discovered while reviewing Ibd3efb92a203861f507ce71bc8d04d19d9d38a93 Change-Id: Ie4dfc1b9b7a99f14657148ed5a935bbb079c2b4e Reviewed-on: https://code.wireshark.org/review/415 Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-26More tvbuff API deprecation, comment expansion, and documentation updates.Guy Harris1-18/+36
Do with tvb_get_stringz() what was done with tvb_get_string(). Redo the comments for the string get routines to try to give more detail in a fashion that's a bit less hard to read. Warn, in comments, of the problems with using tvb_get_string()/tvb_get_stringz() (i.e., if your strings are non-ASCII, all bytes with the 8th bit set are going be replaced by the Unicode REPLACEMENT CHARACTER, and displayed as such). Warn, in a comment, of the problems with tvb_get_const_stringz() (i.e., it gives you raw bytes, rather than guaranteed-to-be-valid UTF-8). Update documentation and release notes appropriately. Change-Id: Ibd3efb92a203861f507ce71bc8d04d19d9d38a93 Reviewed-on: https://code.wireshark.org/review/327 Reviewed-by: Guy Harris <guy@alum.mit.edu>
2014-02-25Clean up some more subversion references in the documentation.Jeff Morriss2-48/+24
Change-Id: Id6cf1a617bff3e09e47933a69d505393502874d1 Reviewed-on: https://code.wireshark.org/review/370 Reviewed-by: Pascal Quantin <pascal.quantin@gmail.com> Reviewed-by: Evan Huus <eapache@gmail.com> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-02-25More explanation of example heuristic code.Evan Huus1-11/+16
Approach suggested by Jeff seems right to me: https://www.wireshark.org/lists/wireshark-dev/201402/msg00198.html Change-Id: I3d54cb49e2f0027ee79f68a633f57382101241b5 Reviewed-on: https://code.wireshark.org/review/350 Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-23Documentation updatesEvan Huus2-38/+15
Change-Id: I6bd7fa40726fe7ffd68b9341c640874f2a0f1c7c Reviewed-on: https://code.wireshark.org/review/314 Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Reviewed-by: Christopher Maynard <Christopher.Maynard@gtech.com> Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-22TVB API deprecations and cleanupEvan Huus2-18/+9
- rename tvb_length and similar to tvb_captured_length and similar; leave #defines in place for backwards-compat, but mark them clearly as deprecated in code comments and in checkAPI - remove tvb_get_string as C code and just leave a #define in place for backwards-compat; mark it clearly as deprecated in code comment and checkAPI - update READMEs and sample dissector for all of the above - while in the neighbourhood, make checkAPI skip (and warn) for missing files instead of bailing on the whole check, so subsequent files still get checked Change-Id: I32fc437896ca86ca73e9b49d5f50400adf8ec5ad Reviewed-on: https://code.wireshark.org/review/311 Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-21Fix bug 9790: Lua: wslua allows duplicate field registrationHadriel Kaplan1-5/+9
As discussed in bug 3513 and 9709, one can register more than one new ProtoFields for the same field name. Of course C-code can do that too, and does a LOT apparently, but if they're not similar ftypes then things can get scrweed up in display filters. So this change prevents duplicate field registration of dissimilar ftypes. The similarity is based on the discussion on the mailing list, and the listing in README.developer has been updated to refelect that as well. Also, this change adds a testscript for Proto/ProtoFields. Change-Id: I43bd323f785245941a21289647332a19adec2a9d Reviewed-on: https://code.wireshark.org/review/285 Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-14Remove $Id$ and other Subversion leftovers from the doc files.Jeff Morriss23-54/+0
Change-Id: I28a376f7e0fd90971f65ae9c1105a3ec85221470 Reviewed-on: https://code.wireshark.org/review/204 Reviewed-by: Jeff Morriss <jeff.morriss.ws@gmail.com>
2014-02-13Lua: add ability for scripts loaded from command-line to be passed argumentsHadriel Kaplan2-0/+14
This change adds the ability to pass on to lua scripts loaded from the command-line (tshark or wireshark) additional arguments supplied by the command-line. This will help us in our testsuites, but also might be useful for user-created scripts. The additional arguments are passed in using the '-X' eXtension switch. Change-Id: Ib94cdf1ffd194ca84692fee7816665e4ff95efbd Reviewed-on: https://code.wireshark.org/review/156 Reviewed-by: Evan Huus <eapache@gmail.com> Tested-by: Evan Huus <eapache@gmail.com>
2014-02-08Licensecheck improvements, just two errors left.Evan Huus3-7/+61
Spawned from https://www.wireshark.org/lists/wireshark-dev/201402/msg00024.html Add some ignore rules for files that can't/shouldn't include a license header. Reorganize some ignore rules to group rules with similar motivations. Add a header to autogen.sh and attribute it to just "The Wireshark Authors" since while Gilbert wrote the original version it's gone through so many changes over the years that sorting out proper authorship is unnecessarily complex. Add headers to Graeme Hewson's two files as verified by private email, and update his address in the AUTHORS file per his request. Add header to one of Ulf Lamping's files, as verified by private email. Only remaining problem is the reedsolomon code. Change-Id: Ifb7de8c4b4d79012553e29d459a0145d39f51df5 Reviewed-on: https://code.wireshark.org/review/145 Reviewed-by: Evan Huus <eapache@gmail.com>
2014-02-07Replace "svn" with "git" all over the place.Gerald Combs1-1/+1
Rename "SVNPATH" to "GITBRANCH" since that seems more appropriate. Rename "svnversion.h" to "version.h" as Evan suggested. Update some URLs. In make-version.pl, make sure we don't set an improper upstream branch name. Use the number of commits + short hash from `git describe` for package names by default. Change-Id: I922bba8d83eabdf49284a119f55b4076bc469b96 Reviewed-on: https://code.wireshark.org/review/139 Reviewed-by: Gerald Combs <gerald@wireshark.org>
2014-02-03Fix all -fstrict-alias warnings found by gcc 4.1.2Gilbert Ramirez1-1/+7
The majority of the fixes are for calls to uat_new(). Instead of having each caller cast its private data to (void**), we use void* in the uat_new() API itself. Inside uat_new(), we cast the void* to void**. Some dissectors use val64_string arrays, so a VALS64() macro was added for those, to avoid using VALS(), which is useful only for value_string arrays. packet-mq.c was changed because dissect_nt_sid() requires a char**, not a guint**. All other callers of dissect_nt_sid() use char*'s (and take the address of it) for their local storage. So, this was changed to follow the other practices. A confusion between gint and absolute_time_display_e in packet-time.c was cleared up. The ugliest fix is the addition of ip6_guint8_to_str(), for exactly one caller. The caller uses one type of ip6 address byte array, while ip6_to_str() expects another. This new function is in place until the various address implementations can be consolidated. Add VALS64() to the developer documentation. Change-Id: If93ff5c6c8c7cc3c9510d7fb78fa9108e4552805 Reviewed-on: https://code.wireshark.org/review/48 Reviewed-by: Evan Huus <eapache@gmail.com> Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org> Reviewed-by: Alexis La Goutte <alexis.lagoutte@gmail.com> Tested-by: Alexis La Goutte <alexis.lagoutte@gmail.com>
2014-01-31Fix for Bug-9709 Lua: class attribute descriptions in API docs don't say if ↵Hadriel Kaplan1-1/+6
an attribute is read/write/both. Also added some minor text to README.wslua for developers. Change-Id: I50b36f06710da6920ad98be6dde27d6091d91d54 Reviewed-on: https://code.wireshark.org/review/50 Reviewed-by: Stig Bjørlykke <stig@bjorlykke.org> Tested-by: Stig Bjørlykke <stig@bjorlykke.org>
2014-01-26GPLv2 -> GPLv2+Jörg Mayer1-2/+2
svn path=/trunk/; revision=54969
2014-01-24Remove some old obsolete text in the proto_tree_add_text() description.Bill Meier1-7/+0
svn path=/trunk/; revision=54943
2014-01-07Update documentation to match change in r54630:Jörg Mayer1-1/+1
"The capabilities for dumpcap don't need to be inheritable." svn path=/trunk/; revision=54639
2014-01-04Minor: update 'Conversation' intro to include find_or_create_conversationBill Meier1-4/+4
svn path=/trunk/; revision=54595
2014-01-01Add proto_tree_add_ts_23_038_7bits_item() / tvb_get_ts_23_038_7bits_string() ↵Pascal Quantin1-0/+31
functions and update dissectors to use it. Remove gsm_sms_char_7bit_unpack() / gsm_sms_chars_to_utf8() functions. Update documentation a bit. svn path=/trunk/; revision=54534
2013-12-26Since the documentation states that, "Text2pcap understands a hexdump of the ↵Chris Maynard1-7/+5
form generated by od -Ax -tx1 -v.", supply an example that actually matches that format. In addition, change the hex bytes so that they represent a valid, well-formed packet, rather than a malformed RSVP packet. This should allow a user to more clearly verify that the text2pcap converstion worked as expected in the event he/she desires to test text2pcap using the example provided. svn path=/trunk/; revision=54454
2013-12-23From Ville Skyttä: Spelling FixesBill Meier4-5/+5
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9591 svn path=/trunk/; revision=54387
2013-12-21make it possible to compile the sample dissector.Jörg Mayer1-2/+6
Fix one trivial error found. Add a missing forward declaration. svn path=/trunk/; revision=54323
2013-12-21Update documentation to reflect the non-existence ofGuy Harris1-3/+0
proto_tree_add_unicode_string(). svn path=/trunk/; revision=54321
2013-12-21Update documentation to reflect removal of tvb_get_unicode_string*, fullGuy Harris1-20/+16
support for (correct) UTF-16, and new string encodings. svn path=/trunk/; revision=54320
2013-12-20Change G_GINT64_CONSTANT(xxxxU) to G_GUINT64_CONSTANT(xxxx)Jakub Zawadzki1-2/+2
svn path=/trunk/; revision=54314
2013-12-13Add a "captype" file that just reports the type of a capture file, basedGuy Harris1-0/+49
on what libwiretap thinks it is. Update some comments to reflect the death of the hack used to include (libwiretap) plugin support in programs not built with libwireshark. svn path=/trunk/; revision=54015
2013-12-11Improve tshark command-line error help. Fixes ↵Chris Maynard1-13/+21
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9548 and adds addtional help, better formatting, sorting and some minimal documentation of the -u option to the tshark man page. svn path=/trunk/; revision=53938
2013-12-08Add a reference to STR_ASCII and STR_UNICODEPascal Quantin1-0/+4
svn path=/trunk/; revision=53868
2013-12-02Specify SI units for the max filesize autostop condition. For now, keep the ↵Chris Maynard3-23/+23
capture buffer size in IEC units, but document it as such. #BACKPORT(1.10, 1.8(?)) svn path=/trunk/; revision=53728
2013-11-30Update documentation for tcp_dissect_pdus. Bug 9491 ↵Michael Mann1-11/+18
(https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9491) From Peter Wu: update to README.dissector From me: update to WSDG_chapter_dissection.xml svn path=/trunk/; revision=53678
2013-11-29Stats_tree enhancements for sorting, averages and burst rate. Bug 9452 ↵Michael Mann1-1/+36
(https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9452) From Deon van der Westhuysen - Bug fix: object leak in stats_tree after a tap reset (for example apply statistics preferences with a stats_tree window open) - Bug fix: correct sample code in README.stats_tree - Add: slash in plug-in name now creates submenu as docs describe (was a bug?) - Add: menu separator before the stat_tree registered plug-ins - Add: stats_tree can now calculate averages for nodes; automatically calculated for range nodes. Add section in README.stats_tree describing averages. - Add: stats_tree can now calculate burst rate of each node (like rate but with a shorter, sliding time window) - Add: sorting for stats_tree plug-ins. Can sort on node name, count, average, min, max values and burst rate. - Add: preferences for stats_tree system (default sort column, burst calc params) - Add: stats_tree window copy to clipboard and export and plain text, csv and XML. - Added sample of new functionality in $srcdir/plugins/stats_tree/pinfo_stats_tree.c - Moved all stats_tree sample plug-ins to "IP Statistics" submenu. svn path=/trunk/; revision=53657
2013-11-29Rename some of pint.h macros to match common style (bits number on the end).Jakub Zawadzki1-3/+3
pntohs -> pntoh16 pntohl -> pntoh32 pletohs -> pletoh16 pletohl -> pletoh32 phtons -> phton16 phtonl -> phton32 svn path=/trunk/; revision=53652
2013-11-14Update the guidelines a bit.Gerald Combs1-3/+13
svn path=/trunk/; revision=53331
2013-11-08Add reference to qttools5-dev in README.qt documentationAlexis La Goutte1-1/+1
There is following error message with cmake : CMake Warning at CMakeLists.txt:490 (find_package): By not providing "FindQt5LinguistTools.cmake" in CMAKE_MODULE_PATH this project has asked CMake to find a package configuration file provided by "Qt5LinguistTools", but CMake did not find one. Could not find a package configuration file provided by "Qt5LinguistTools" with any of the following names: Qt5LinguistToolsConfig.cmake qt5linguisttools-config.cmake Add the installation prefix of "Qt5LinguistTools" to CMAKE_PREFIX_PATH or set "Qt5LinguistTools_DIR" to a directory containing one of the above files. If "Qt5LinguistTools" provides a separate development package or SDK, be sure it has been installed. CMake Error at ui/qt/CMakeLists.txt:205 (QT5_ADD_TRANSLATION): Unknown CMake command "QT5_ADD_TRANSLATION". svn path=/trunk/; revision=53169
2013-11-06Add support for displaying dates as year and day-of-year (1-origin).Guy Harris3-30/+68
In the process, fix various man page descriptions of the -t flag, and add support for UTC absolute times in the iousers and iostat TShark taps. svn path=/trunk/; revision=53114
2013-11-01Remove a phrase which implies that tab widths other than 8 are OK.Bill Meier1-4/+4
svn path=/trunk/; revision=53030
2013-11-01Clarify which filter types can share the same namePascal Quantin1-0/+8
svn path=/trunk/; revision=53017
2013-10-30Add some documentation to hopefully help dissector writers avoid the problemJeff Morriss1-2/+3
in https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9323 : The string added to proto_tree_add_string*() must be NULL terminated. svn path=/trunk/; revision=52984
2013-10-27More SVN properties cleanup.Jeff Morriss1-1/+1
svn path=/trunk/; revision=52884
2013-10-25Sync up with packet-pana.c.Chris Maynard1-6/+6
svn path=/trunk/; revision=52852
2013-10-25wmemify.Chris Maynard1-10/+9
svn path=/trunk/; revision=52851
2013-10-23Add the ability to collapse subtrees with Shift+Left + additional menu ↵Michael Mann1-2/+2
items. Bug 9008 (https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9008). Currently this is only for GTK, but allows users to test it to see if its worth adding to Qt (my personal opinion is yes). From Jiří Engelthaler svn path=/trunk/; revision=52790
2013-10-15From Ed Beroset via https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=9272Chris Maynard1-13/+40
Add tshark -G column-formats report and document the missing ftypes, heuristic-decodes and plugins reports. From me: Sort the reports. Add modelines to epan/column.c. Minor whitespace changes. svn path=/trunk/; revision=52627
2013-10-13Subsume README.binarytrees into wmem doxygen. The README was out of dateEvan Huus5-248/+0
anyways, since Michael made key operations non-destructive in r44380. svn path=/trunk/; revision=52583