Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
dqtool(1)		  The dqtool tool manual page		     dqtool(1)

NAME
       dqtool  ---  Display the	contents of a disk-buffer file created with {{
       site.product.short_name }}.

Synopsis
       dqtool [command]	[options]

Description
       NOTE: The dqtool	application is distributed with	the syslog-ng OSE sys-
       tem logging application,	and is usually part of the syslog-ng OSE pack-
       age. The	latest version of the syslog-ng	OSE application	 is  available
       at the syslog-ng	OSE page.

       This manual page	is only	an abstract.

       The  dqtool  application	 is  a utility that can	be used	to display and
       format the messages stored in a disk-buffer file.

The cat	command
	      cat [options] [file]

       Use the	cat  command  to  display  the	log  messages  stored  in  the
       disk-buffer  (also  called  disk-queue) file, and also information from
       the header of the disk queue file. The  messages	 are  printed  to  the
       standard	output (stdout), so it is possible to use grep and other tools
       to  find	particular log messages, for example, dqtool cat /var/log/mes-
       sages.lgs |grep 192.168.1.1.

       The cat command has the following options:

	      	--debug	or -d

	      Print diagnostic and debugging messages to stderr.

	      	--help or -h

	      Display a	brief help message.

	      	--template=<template> or -t

	      Format the messages using	the specified template.

	      	--verbose or -v

	      Print verbose messages to	stderr.

	      	--version or -V

	      Display version information.

   Example: The	cat command
	      ./dqtool cat ../var/syslog-ng-00000.qf

       The output looks	like:

	      Disk-buffer state	loaded;	 filename='../var/syslog-ng-00000.qf',
	      qoutlength='65',	 qbackloglength='0',   qoverflowlength='9205',
	      qdisklength='0' Mar  3 10:52:05  tristram	 localprg[1234]:  seq:
	      0000011630,  runid:  1267609923, stamp: 2010-03-03T10:52:05 PAD-
	      DPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPAD-
	      DPADDPADDPADDPADDPADDPADDPADDPADDPADDPADD	Mar  3 10:52:05	 tris-
	      tram  localprg[1234]: seq: 0000011631, runid: 1267609923,	stamp:
	      2010-03-03T10:52:05 PADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPAD-
	      DPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADDPADD

The relocate command
	      relocate [options] [files]

       Use the relocate	command	to move	or  rename  disk-buffer	 (also	called
       disk-queue)  files.  Note  that	this option modifies the persist file.
       Stop syslog-ng OSE before using this command.

       The relocate command has	the following options:

	      	--all or -a

	      Relocate every disk-buffer file that is listed in	the  syslog-ng
	      OSE persist file.

	      	--new_path or -n

	      The directory where you want to move the disk-bufffer files. For
	      example: /var/disk-buffers

	      	--persist or -p

	      The path to the syslog-ng	OSE persist file. The relocate command
	      automatically  updates  the  entries of the disk-buffer files in
	      the persist file.

   Examples
       Relocate	a single queue file:

	      bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist /tmp/syslog-ng-00000.rqf

       Relocate	multiple queue files:

	      bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist /tmp/syslog-ng-00000.rqf /tmp/syslog-ng-00001.rqf

       Relocate	every queue file:

	      bin/dqtool relocate --new_path /tmp/dq --persist var/syslog-ng.persist --all

Files
       dqtool

       NOTE: If	you experience any problems or need help with  syslog-ng  OSE,
       see  the	 syslog-ng OSE Administration Guide[1],	or visit the syslog-ng
       OSE mailing list[2].  For news and notifications	about  syslog-ng  OSE,
       visit the syslog-ng OSE blogs[3].

AUTHOR
       This  manual  page  was generated from the syslog-ng OSE	Administration
       Guide[1], which was written by several contributors to whom  we'd  like
       to extend our sincere thanks.

COPYRIGHT
NOTES
       [1] syslog-ng OSE Administration	Guide
	   <https://syslog-ng.github.io/admin-guide/README>

       [2] syslog-ng OSE mailing list
	   <https://lists.balabit.hu/mailman/listinfo/syslog-ng>

       [3] syslog-ng OSE blogs
	   <https://syslog-ng.com/blog/>

4.9.0			       03 September 2025		     dqtool(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=dqtool&sektion=1&manpath=FreeBSD+Ports+15.0>

home | help