vRoach v1.431 Beta
-
User Manual

 



 
 
 
 
 
 
 
 

Table of Contents...

 
Introduction
Stuff about this manual

What is vRoach?

Why was it built?

How does it work?


 
Misc
Contact

Stuff about this manual...                                                     up
  • Please note that this manual will make frequent references to the free version of vRoach bundled with the open source Dev-C++ IDE (very popular win32 front end for GCC). It is highly recommended that the reader downloads Dev-C++, as this is an excellent way for them to see vRoach in action.
  • All the graphics on this page are encoded in .png format. If they look messed, it is probably because your browser is too old and crappy. I have noticed that Konqueror, Opera, Mozilla, and Netscape 4.x seem to work just fine.
  • This manual assumes that the reader has a basic knowledge of the Winblows operating system. Developer knowledge is not required, but it will be an asset.
  • Note that the pictures in here may not reflect what vRoach really looks like. vRoach gets better and better every day so some things may be different in the version you have.

What is vRoach?                                                               up

vRoach is a portable bug submitter (also known as a feedback agent). By portable I mean it is a stand alone component that can be wired into virtually any existing software package. vRoach gives your clients the ability to assist your developers in locating bugs or sending feedback through a familiar and friendly interface. vRoach is fast and can be used on the fly so you do not have to stop what you are doing. It is also capable of sending optional information that developers tend to need when diagnosing a problem remotely (ie operating system version, build numbers, screen resolution, etc).
 

Why was it built?                                                              up

It occurred to me that most of the bugs that exist in any given software package are almost always discovered by your clients. The client, unlike the developer, will do things with your application that you would never have thought of. vRoach allows your clients to communicate fast and on the fly with your developers in a way that is productive. It can generate and email a report that includes the user's comments and optionally their system specifications / configuration files. Therefore, vRoach gives your clients the ability to search, and the developers the ability to destroy. Paired up with something like vUpdate can prove to be lethal.
 

How does it work?                                                              up

Here is a step by step example of a typical vRoach scenario with the Dev-C++ IDE...

Step One - Enter information

User begins by entering in details as to what they were doing at the time of the incident. The interface was designed to be self explanatory and very logical.


 
Step Two - Select options

The user then selects extra information they may wish to make available to the developers.


 
Step Three - Report sent

A report is pieced together and emailed off to a pre specified address. Please note that it is possible to have the report sent to an unlimited amount of addresses. Here is an example report from the above figure...

vRoach Version: vRoach 1.431 Beta
Submitted by: Kip
Total submits: 1
Email: kip@zero47.com
Comment: Dev-C++ crashed when I hit the ok button in the options dialog box

System specification...
=========================================
Platform ID: Winblows NT
Platform Version: 5.0
Platform Build Number: 2195
Platform Extra Info: Service Pack 3
Screen Resolution: 1280 by 1024

=========================================

Program configuration settings...
=========================================
User's devcpp.ini...
/\------------------------------------/\
[Editor.Syntax]
Assembler=clLime, clNone, 0, 0, 0
Character=$00FF6633, clNone, 0, 0, 0
Comment=$00FF6633, clNone, 0, 1, 0
Float=clFuchsia, clNone, 0, 0, 0
Hexadecimal=clFuchsia, clNone, 0, 0, 0
Identifier=clLime, clNone, 0, 0, 0
Illegal char=clRed, clMaroon, 0, 0, 0
Number=clBlue, clNone, 0, 0, 0
Octal=clFuchsia, clNone, 0, 0, 0
Preprocessor=clLime, clNone, 0, 0, 0
Reserved word=clGreen, clNone, 0, 0, 0
Space=clWhite, clBlack, 0, 0, 0
String=$00C3C3C3, clNone, 0, 0, 0
Symbol=clLime, clNone, 0, 0, 0
Gutter=65280, 0
Break points=16777215, 8421504
Error Line=16777215, 255
Active Breakpoints=16777215, 16711680
Selected text=16777215, 8388608

[Editor]
UseSyntax=1
AutoIndent=1
InsertMode=1
TabToSpaces=1
SmartTabs=0
SmartUnindent=1
TrailBlank=0
GroupUndo=1
EHomeKey=0
PastEOF=0
PastEOL=0
DblClkLine=0
FindText=1
Scrollbars=1
HalfPageScroll=0
ScrollHint=1
SpecialChars=0
AutoCloseBrace=0
TabSize=4
MarginVis=1
MarginSize=80
MarginColor=-2147483634
InsertCaret=0
OverwriteCaret=0
InsDropFiles=0
GutterVis=1
GutterAuto=0
LineNumbers=1
LeadZero=0
FirstLineZero=0
Gutterfnt=1
GutterSize=32
SyntaxExt="c;cpp;h;hpp"
DefaulttoPrj=0
[Options]
Language="English (Original)"
Theme="Gnome"
First=0
Splash=""
MRUMax=10
DblFiles=0
NoSplashScreen=0
MinOnRun=0
OpenStyle=1
BackUps=1
AutoOpen=2
MsgTabs=1
ShowBars=0
ShowMenu=0
DefCpp=1
ShowOutput=0
OutputOnNeed=0
OutputHeight=120
ProjectView=1
ClassView=0
ProjectWidth=161
Statusbar=1
FullScreen=0
FindCols="75, 75, 120, 150"
CompCols="75, 75, 120"
ToolbarMain=1
ToolbarMainX=11
ToolbarMainY=2
ToolbarEdit=1
ToolbarEditX=333
ToolbarEditY=2
ToolbarCompile=1
ToolbarCompileX=201
ToolbarCompileY=2
ToolbarProject=1
ToolbarProjectX=393
ToolbarProjectY=2
ToolbarOptions=1
ToolbarOptionsX=881
ToolbarOptionsY=2
ToolbarSpecials=1
ToolbarSpecialsX=628
ToolbarSpecialsY=2
ToolbarSearch=1
ToolbarSearchX=514
ToolbarSearchY=2
[Position]
WinPlace=2, 3, -1, -1, -1, -1, 201, 147, 1078, 876
[Directories]
Bins="d:\dev\compilers\DevCpp5\Bin;d:\dev\compilers\DevCpp5\lib\gcc-lib\mingw32\2.95.3-6"
Default="d:\dev\compilers\DevCpp5\"
C="d:\dev\compilers\DevCpp5\include"
Cpp="d:\dev\compilers\DevCpp5\include\g++-3;d:\dev\compilers\DevCpp5\include"
Help="Help\"
Icons="Icons\"
Lang="Lang\"
Lib="d:\dev\compilers\DevCpp5\lib"
Templates="Templates\"
Themes="Themes\"
[Compiler]
UseParams=1
InterDir=
OutputDir=
RunParams=
CompAdd=0
LinkAdd=0
cmdline=
LinkLine=
Log=0
Delay=0
gcc.exe=gcc.exe
g++.exe=g++.exe
gdb.exe=gdb.exe
make.exe=make.exe
windres.exe=windres.exe
dllwrap.exe=dllwrap.exe
gprof.exe=gprof.exe
[C++_Compiler]
Heuristics=0
AccessChecking=0
AcceptDollar=0
[C_Compiler]
Ansi=0
Traditional=0
Warning=0
UseCygwin=0
[Optimization]
MinorOpt=1
Optimization=3
[Makefile]
FastDep=0
[Profiling]
Profile=0
[Code_Generation]
Exceptions=0
DoubleFloat=0
Memory=0
[Linker]
ObjC=0
DebugInfo=0
NoLibs=0
Win32=1
[Editor.Font]
Charset=1
Color=-2147483640
Name="Courier New"
Pitch=0
Size=10
[Editor.Gutterfont]
Charset=1
Color=-2147483640
Name="Terminal"
Pitch=0
Size=9
[CodeCompletion]
Width=320
Height=240
Delay=500
BackColor=-2147483643
Enabled=0
[ClassBrowsing]
Enabled=0
ViewStyle=0
ParseLocalHeaders=0
ParseGlobalHeaders=0
ShowAllClasses=0
[History]
0=D:\projects\vRoach\src\vRoach.dev
1=D:\projects\vDict\src\vDict.dev
2=D:\projects\vUpdate\src\vUpdate.dev
3=D:\dev\Compilers\bcc55\Include\winsock2.h
4=D:\projects\vDict\src\keygen\vDictKeyGen.cpp
5=C:\Documents and Settings\Administrator\Desktop\test.cpp
6=D:\projects\vRoach\src\DialogProc.c

\/------------------------------------\/

User's devcpp.cfg...
/\------------------------------------/\
[Tools]
Count=1

[Tool0]
Title=vRoach
Program=vRoach.exe
WorkDir=d:\dev\compilers\devcpp5
Params=
[VUPDATE]
AdvancedBandwidthThrottle = "100.000000"
AdvancedDebugLog = "0"
ListOther = "1"
ListHelp = "1"
ListLanguages = "1"
ListPatches = "1"
ListPackages = "1"
InterfacePreviews = "0"
InterfaceDevTheme = "1"
InterfaceSmoothProgressBar = "1"
$ROOT="d:\dev\compilers\DevCpp5\"
$BIN="d:\dev\compilers\DevCpp5\Bin"
$HELP="D:\dev\Compilers\DevCpp5\Help\"
$ICONS="D:\dev\Compilers\DevCpp5\Icons\"
$INCLUDE="d:\dev\compilers\DevCpp5\include"
$LIB="d:\dev\compilers\DevCpp5\lib"
$LANG="D:\dev\Compilers\DevCpp5\Lang\"
$TEMPLATES="D:\dev\Compilers\DevCpp5\Templates\"
$THEMES="D:\dev\Compilers\DevCpp5\Themes\"

\/------------------------------------\/

User's devshortcuts.cfg...
/\------------------------------------/\
[Shortcuts]
Source File=Ctrl+N
Project...=
Resource File=
Template...=
Open Project or File...=Ctrl+O
Clear History=
Save=Ctrl+S
Save As...=Ctrl+F12
Save All=
Close=
Close All=
Close Project=
Properties=
Import MS Visual C++ project=
to HTML=
to RTF=
Project to HTML=
Print=Ctrl+P
Print Setup=
Exit=
Undo=Ctrl+Z
Redo=Shift+Ctrl+Z
Cut=Ctrl+X
Copy=
Paste=Ctrl+V
Swap header/source=
Date/Time=
Comment Header=
Select All=Ctrl+A
Comment=Ctrl+Alt+.
Uncomment=Ctrl+Alt+,
Indent=Ctrl+I
Unindent=Ctrl+U
Find...=Ctrl+F
Find in Files...=Shift+Alt+F
Search Again=F3
Replace...=Ctrl+R
Incremental Search=Ctrl+I
Goto function...=Shift+Ctrl+G
Goto line...=Ctrl+G
Project/Class Browser=
Statusbar=
Always Visible=
Only when Needed=
Main=
Edit=
Search=
Compile and Run=
Project=
Options=
Specials=
To-Do list...=
New unit=
Add to Project=
Remove from Project=
Add Resource File...=
Remove Resource File...=
Edit Resource File...=
Project Options=Alt+P
Compile=Ctrl+F9
Run=Ctrl+F10
Compile & Run=F9
Rebuild All=Ctrl+F11
Syntax Check=
Clean=Ctrl+Alt+F12
Profile analysis=
Program Reset=Alt+F2
Debug=F8
Stop Execution=Alt+F2
Toggle Breakpoint=Ctrl+F5
Next Step=F7
Step Into=Shift+F7
Step Over=Ctrl+F7
Run to Cursor=Ctrl+F4
Add Watch=F4
Watch Variables=Ctrl+W
View CPU Window=
Compiler Options=
Environment Options=
Editor Options=
Configure Shortcuts=
Configure Tools=
Check for Updates/Packages...=Ctrl+Alt+V
Full Screen Mode=F12
Next=F6
Previous=F5
Customize Help Menu...=
About Dev-C++...=
Close all except this=
Delete=
Add To-Do item...=Shift+Ctrl+T
Remove file=
Rename file=
Open=
Add folder=
Remove folder=
Rename folder=
Clear=
Goto declaration=
Goto implementation=
New class=
New member function=
New variable=
All files=
Current file=
Edit watch=
Remove watch=

\/------------------------------------\/

User's vUpdate Install Database.txt...
/\------------------------------------/\
# This file is generated by vUpdate and is used to keep
# track of what has already been installed. It is highly
# recommend that you don't edit its contents unless you
# know what you are doing. Doing so can result in
# either yourself or vUpdate going mad.

# Chinese language Installed on Fri Aug 02 03:26:54 2002
LangChinese
1.5

# English language Installed on Fri Aug 02 03:27:10 2002
LangEnglish
1.60

# Czech language Installed on Fri Aug 02 13:10:03 2002
LangCzech
1.3

# Danish language Installed on Fri Aug 02 13:10:08 2002
LangDanish
1.2

# Dutch language Installed on Fri Aug 02 13:10:10 2002
LangDutch
1.25

# French language Installed on Fri Aug 02 13:10:25 2002
LangFrench
1.34

# German language Installed on Fri Aug 02 13:10:27 2002
LangGerman
1.17

# Greek language Installed on Fri Aug 02 13:10:45 2002
LangGreek
1.36

# Italian language Installed on Fri Aug 02 13:10:46 2002
LangItalian
1.4

# Korean language Installed on Fri Aug 02 13:10:48 2002
LangKorean
1.4

# Polish language Installed on Fri Aug 02 13:10:53 2002
LangPolish
1.1

# Portuguese language Installed on Fri Aug 02 13:10:55 2002
LangPortuguese
1.5

# Spanish language Installed on Fri Aug 02 13:10:57 2002
LangSpanish
1.2

# FLTK Installed on Sat Aug 03 14:33:28 2002
fltk
1.10

# Chinese TC language Installed on Mon Aug 05 15:35:16 2002
LangChineseTC
1.4

# Dev-C++ installed on Tue Aug 06 17:57:02 2002
DevCppExe
1.76

# vRoach 1.431 Beta installed on Wed Aug 21 20:04:46 2002
vRoach
1.431
\/------------------------------------\/

User's vUpdate Debug Log.txt...
/\------------------------------------/\
# v1.509 Wed Aug 21 20:03:06 2002
According to your devcpp.cfg, vUpdate thinks these are your macros...
$ROOT: "d:\dev\compilers\DevCpp5\"
$BIN: "d:\dev\compilers\DevCpp5\Bin"
$HELP: "D:\dev\Compilers\DevCpp5\Help\"
$ICONS: "D:\dev\Compilers\DevCpp5\Icons\"
$INCLUDE: "d:\dev\compilers\DevCpp5\include"
$LIB: "d:\dev\compilers\DevCpp5\lib"
$LANG: "D:\dev\Compilers\DevCpp5\Lang\"
$TEMPLATES: "D:\dev\Compilers\DevCpp5\Templates\"
$THEMES: "D:\dev\Compilers\DevCpp5\Themes\"

# v1.509 Wed Aug 21 20:03:06 2002
According to your devcpp.cfg, vUpdate thinks these are your options...
bInterfaceSmoothProgressBar: "1"
bInterfaceDevTheme: "1"
bInterfacePreviews: "0"
bListPackages: "1"
bListPatches: "1"
bListLanguages: "1"
bListHelp: "1"
bListOther: "1"
bAdvancedDebugLog: "1"
fBandwidthThrottle: "100.000000"

# v1.509 Wed Aug 21 20:03:06 2002
Status: Ready, hit start to begin...

# v1.509 Wed Aug 21 20:03:08 2002
According to your devcpp.cfg, vUpdate thinks these are your macros...
$ROOT: "d:\dev\compilers\DevCpp5\"
$BIN: "d:\dev\compilers\DevCpp5\Bin"
$HELP: "D:\dev\Compilers\DevCpp5\Help\"
$ICONS: "D:\dev\Compilers\DevCpp5\Icons\"
$INCLUDE: "d:\dev\compilers\DevCpp5\include"
$LIB: "d:\dev\compilers\DevCpp5\lib"
$LANG: "D:\dev\Compilers\DevCpp5\Lang\"
$TEMPLATES: "D:\dev\Compilers\DevCpp5\Templates\"
$THEMES: "D:\dev\Compilers\DevCpp5\Themes\"

# v1.509 Wed Aug 21 20:03:08 2002
According to your devcpp.cfg, vUpdate thinks these are your options...
bInterfaceSmoothProgressBar: "1"
bInterfaceDevTheme: "1"
bInterfacePreviews: "0"
bListPackages: "1"
bListPatches: "1"
bListLanguages: "1"
bListHelp: "1"
bListOther: "1"
bAdvancedDebugLog: "1"
fBandwidthThrottle: "100.000000"

# v1.509 Wed Aug 21 20:03:19 2002
Preparing to save macros and options......

# v1.509 Wed Aug 21 20:03:19 2002
Saving your options...

# v1.509 Wed Aug 21 20:03:19 2002
Saved options...

\/------------------------------------\/

=========================================
 
 

Questions, comments, and suggestions about vRoach
can be sent to kip@zero47.com. Good luck. L8tr.

Contact                                                                         up

E-Mail: kip@zero47.com
Website: http://www.zero47.com
ICQ: 29008229