Skip to content

Commit

Permalink
Updated the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@pweerd
pweerd committed May 15, 2020
1 parent 727d894 commit ff8d2e2
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions help.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -228,12 +228,12 @@
<body class='typora-export os-windows' >
<div id='write' class = 'is-node'><h1><a name="bigfile-v093" class="md-header-anchor"></a><span>BigFile (V0.9.3)</span></h1><p><span>BigFile is meant as a viewer for large files on Windows. Like &#39;less&#39; on Unix systems.</span>
<span>The following provides a brief help guide for the core operations of BigFile.</span></p><h2><a name="history" class="md-header-anchor"></a><span>History</span></h2><p><span>BigFile is inspired by Woanware&#39;s LogViewer (</span><a href='https://github.com/woanware/LogViewer' target='_blank' class='url'>https://github.com/woanware/LogViewer</a><span>)</span>
<span>Unfortunately BigFile diverged way too far from the original logviewer, so I decided it deserves its own place.</span></p><h2><a name="opening-a-file" class="md-header-anchor"></a><span>Opening a file</span></h2><p><span>Either use the File-&gt;Open menu item or drag and drop a file onto the list</span></p><p><span>BigFile can open </span><strong><span>.zip</span></strong><span> and </span><strong><span>.gz</span></strong><span> files directly. The content will be loaded into memory and served from there. gz-files will be loaded via an internal zlib implementation if found, or via SharpZLib (slower!) .zip files will be loaded via the internal .Net zip-classes. </span></p><p><span>In case of a zip archive, the largest sub-file will be loaded. Also, a dropdown box with all entries from the zip file is shown. Selecting a different entry from that dropdown will load the associated zip entry from the archive. </span></p><p><span>The load process is done in the background but regularly sends a partial loaded file to the user-interface, to make it possible to view the file before it is completely loaded.</span></p><p><span>All background processing can be cancelled by pressing the escape-key, or by clicking in the progress bar.</span></p><p><a name="search"></a></p><h2><a name="search-n12" class="md-header-anchor"></a><span>Search</span></h2><p><span>If the searchbox contains any of AND, OR, NOT, the search is considered to be a boolean search. Otherwise it is a 1-term search.</span>
<span>Unfortunately BigFile diverged way too far from the original logviewer, so I decided it deserves its own place.</span></p><h2><a name="opening-a-file" class="md-header-anchor"></a><span>Opening a file</span></h2><p><span>Either use the File-&gt;Open menu item or drag and drop a file onto the list</span></p><p><span>BigFile can open </span><strong><span>.zip</span></strong><span> and </span><strong><span>.gz</span></strong><span> files directly. The content will be loaded into memory and served from there. gz-files will be loaded via an internal zlib implementation if found, or via SharpZLib (slower!) .zip files will be loaded via the internal .Net zip-classes. </span></p><p><span>In case of a zip archive, the largest sub-file will be loaded. Also, a dropdown box with all entries from the zip file is shown. Selecting a different entry from that dropdown will load the associated zip entry from the archive. </span></p><p><span>The load process is done in the background but regularly sends a partial loaded file to the user-interface, to make it possible to view the file before it is completely loaded.</span></p><p><span>All background processing can be cancelled by pressing the escape-key, or by clicking in the progress bar.</span></p><p><a name="search"></a></p><h2><a name="search-n1093" class="md-header-anchor"></a><span>Search</span></h2><p><span>If the searchbox contains any of AND, OR, NOT, the search is considered to be a boolean search. Otherwise it is a 1-term search.</span>
<span>Also, search types can be specified via a &#39;:&#39;.</span>
<span>Following types are supported:</span></p><ul><li><span>no type: case </span><strong><em><span>in</span></em></strong><span>sensitive search</span></li><li><span>cs: case sensitive search</span></li><li><span>regex or r: case </span><strong><em><span>in</span></em></strong><span>sensitive search by a regex</span></li><li><span>rcs: case sensitive search by a regex</span></li></ul><h4><a name="example" class="md-header-anchor"></a><span>Example</span></h4><ul><li><span>(Paris AND r:on$) NOT cs:Amsterdam </span><br/><span>This will match &#39;paris londoN amsterdam&#39;, but not &#39;paris londoN Amsterdam&#39;</span></li><li><span>Paris</span><br/><span>This will do a case insensitive search with 1 term</span></li><li><span>&#39;windows app&#39; NOT unix </span></li></ul><h4><a name="caching" class="md-header-anchor"></a><span>Caching</span></h4><p><span>The last used 20 individual terms from a boolean expression are cached in a bitset. This makes subsequent searching for the same terms blazingly fast. </span></p><p><span>If you search for paris OR amsterdam, it may take a while. But if you search for paris AND amsterdam afterwards, it is only a bitset operation which is typically sub-second. </span></p><p><span>In very large files it might be a good trick to do a search for all terms you might want to search for, combined with OR. Afterwards, searching for any combination of these cched terms is really fast.</span></p><h4><a name="result" class="md-header-anchor"></a><span>Result</span></h4><p><span>When the first match is encountered, the view is positioned to the first hit, while the search proceeds in the background.</span></p><p><span>In the mean time you can navigate to the next search by pressing &#39;/&#39; or F3 in the view window.</span></p><h2><a name="navigation" class="md-header-anchor"></a><span>Navigation</span></h2><p><span>Bigfile mimics some of the less shortcuts. Shortcuts are:</span></p><ul><li><span>&lt; or CTRL-Home</span><br/><span>goto the top</span></li><li><span>&gt;</span><span> or CTRL-End</span><br/><span>goto the bottom</span></li><li><span>/ or F3</span><br/><span>goto the next hit </span></li><li><span>? or CTRL-F3</span><br/><span>goto the previous hit</span></li><li><span>CTRL-G</span><br/><span>Goto a line number</span></li></ul><h2><a name="filtering" class="md-header-anchor"></a><span>Filtering</span></h2><p><span>There are two modes for filtering; hide matched and show matched. Filtering and filter clearing is accessed via the list context menu.</span></p><ul><li><strong><span>Show matched</span></strong><span>: Hides all lines where there is not a search match; therefore only show the matched lines</span></li><li><strong><span>Hide matched</span></strong><span>: Hides the lines that matched the search; therefore only show the lines that don&#39;t match</span></li></ul><h2><a name="detail-view" class="md-header-anchor"></a><span>Detail view</span></h2><p><span>If you double click on a line, a new form is opened where the current line is viewed in a textbox. The form will be reused whenever a different line is opened, unless you you the alt-key. Using the alt-key makes sure that a new window is opened.</span></p><p><span>The formatting can be changed between auto (default), text, json, xml and csv.</span>
<span>In auto-mode, a quick check is done for the content type and the text is formatted in that content type. In case of errors, it is shown as text.</span>
<span>Some formatters support a &#39;normalized&#39; mode (click the wrench button). For instance, when normalize mode, all keys in a json object will be sorted. </span></p><p><span>Eventual hits (after a search) are highlighted, and one can navigate between the hits via the same navigation keys as in the main window.</span></p><h4><a name="searching-in-detail-view" class="md-header-anchor"></a><span>Searching in detail view</span></h4><p><span>By default the search terms from the main form are used in the detail view. However, you can enter more or other terms in the searchbox. Pressing enter or click &#39;search&#39; will navigate to the highlighted hit in the record.</span></p><p><span>Search terms follow the same </span><a href='#search'><span>syntax</span></a><span> as in the main window, with the exception that boolean expressions (AND, OR, NOT) are not supported. Matching is done by simply searching in the complete text.</span></p><h4><a name="navigation-in-detail-view" class="md-header-anchor"></a><span>Navigation in detail view</span></h4><ul><li><span>/ or F3</span><br/><span>goto the next hit in the record </span></li><li><span>? or CTRL-F3</span><br/><span>goto the previous hit in the record</span></li><li><span>CTRL-up</span><br/><span>goto the previous line. </span></li><li><span>CTRL-down</span><br/><span>goto the next line. </span></li></ul><h2><a name="memory" class="md-header-anchor"></a><span>Memory</span></h2><p><span>Non zip/gz files can be served from disk or from memory. Compressed files are always served from memory.</span></p><p><span>Because the content is splitted into lines, the content needs to be read completely for non compressed files as well. So using a memory buffer makes sense there as well.</span></p><p><span>For very large files it is difficult to keep them in memory. Bigfile uses LZW compression to compress large chunks of memory. Because LZW is extremely fast, this combination is typically faster when the system would need to swap memory.</span></p><p><span>On my laptop Bigfile loads a 2GB gz json file in ~1 minute into memory (raw: 15GB, LZW compressed ~3GB).</span></p><p><span>The exact behavior can be configured via tools-&gt;settings.</span></p><h2><a name="copy-line" class="md-header-anchor"></a><span>Copy Line</span></h2><p><span>The selected line&#39;s contents can be copied to the clipboard via the list context menu. There is a maximum limit of 10000 lines. Also, big lines (&gt; 10MB) will be truncated to prevent an out-of-memory </span></p><h2><a name="export" class="md-header-anchor"></a><span>Export</span></h2><p><span>The export function can export </span></p><ul><li><span>all lines</span></li><li><span>selected lines</span></li><li><span>matched lines</span></li></ul><p><span>The export is always line based. Meaning that if splitting of large lines is active, and one selects only a part of the line, the complete line will be exported.</span>
<span>GZip compression of the export file is possible by selecting a .gz extension. </span></p><p><span>Currently, exported lines are terminated by a windows crlf. </span></p><p><span>The export functionality is accessed via the &#39;tools&#39; menu.</span></p><h2><a name="command-line" class="md-header-anchor"></a><span>Command line</span></h2><p><span>The 1st parameter is the file or directory to be opened. If the parameter indicates a directory, an open file dialog box is shown with the supplied directory as initial directory.</span></p><h2><a name="credits" class="md-header-anchor"></a><span>Credits</span></h2><ul><li><span>Mark Woan (</span><a href='https://www.woanware.co.uk' target='_blank' class='url'>https://www.woanware.co.uk</a><span>)</span></li><li><span>SharpZipLib (</span><a href='https://github.com/icsharpcode/SharpZipLib' target='_blank' class='url'>https://github.com/icsharpcode/SharpZipLib</a><span>)</span></li><li><span>ObjectListView (</span><a href='http://objectlistview.sourceforge.net/cs/index.html' target='_blank' class='url'>http://objectlistview.sourceforge.net/cs/index.html</a><span>)</span></li><li><span>LZ4 - Fast LZ compression algorithm (</span><a href='http://fastcompression.blogspot.com/p/lz4.html' target='_blank' class='url'>http://fastcompression.blogspot.com/p/lz4.html</a><span>)</span></li><li><span>ZLib (</span><a href='https://github.com/madler/zlib' target='_blank' class='url'>https://github.com/madler/zlib</a><span>)</span></li><li><span>Icons8 (</span><a href='https://icons8.com' target='_blank' class='url'>https://icons8.com</a><span>)</span></li></ul><p>&nbsp;</p><h2><a name="changes" class="md-header-anchor"></a><span>Changes</span></h2><h4><a name="v093-may-2020" class="md-header-anchor"></a><span>V0.93 (may 2020)</span></h4><ul><li><span>Gzip saving of export files is supported.</span></li><li><span>More (de-)selection possibilities. Selections are now handled by the logfile itself, since the ListView was way too slow.</span></li><li><span>Bugfixes.</span></li></ul><h4><a name="v092-feb-2020" class="md-header-anchor"></a><span>V0.92 (feb 2020)</span></h4><ul><li><span>Gzip loading is now done via an internal zlib implementation.</span>
<span>GZip compression of the export file is possible by selecting a .gz extension. </span></p><p><span>Currently, exported lines are terminated by a windows crlf. </span></p><p><span>The export functionality is accessed via the &#39;tools&#39; menu.</span></p><h2><a name="command-line" class="md-header-anchor"></a><span>Command line</span></h2><p><span>The 1st parameter is the file or directory to be opened. If the parameter indicates a directory, an open file dialog box is shown with the supplied directory as initial directory.</span></p><h2><a name="credits" class="md-header-anchor"></a><span>Credits</span></h2><ul><li><span>Mark Woan (</span><a href='https://www.woanware.co.uk' target='_blank' class='url'>https://www.woanware.co.uk</a><span>)</span></li><li><span>SharpZipLib (</span><a href='https://github.com/icsharpcode/SharpZipLib' target='_blank' class='url'>https://github.com/icsharpcode/SharpZipLib</a><span>)</span></li><li><span>ObjectListView (</span><a href='http://objectlistview.sourceforge.net/cs/index.html' target='_blank' class='url'>http://objectlistview.sourceforge.net/cs/index.html</a><span>)</span></li><li><span>LZ4 - Fast LZ compression algorithm (</span><a href='http://fastcompression.blogspot.com/p/lz4.html' target='_blank' class='url'>http://fastcompression.blogspot.com/p/lz4.html</a><span>)</span></li><li><span>ZLib (</span><a href='https://github.com/madler/zlib' target='_blank' class='url'>https://github.com/madler/zlib</a><span>)</span></li><li><span>Icons8 (</span><a href='https://icons8.com' target='_blank' class='url'>https://icons8.com</a><span>)</span></li></ul><p>&nbsp;</p><h2><a name="changes" class="md-header-anchor"></a><span>Changes</span></h2><h4><a name="v093-may-2020" class="md-header-anchor"></a><span>V0.93 (may 2020)</span></h4><ul><li><span>Gzip saving of export files is supported.</span></li><li><span>More (de-)selection possibilities. Selections are now handled by the logfile itself, since the ListView was way too slow.</span></li><li><span>Line view supports expansion of json, if the json contained strings with encoded json. </span></li><li><span>Bugfixes.</span></li></ul><h4><a name="v092-feb-2020" class="md-header-anchor"></a><span>V0.92 (feb 2020)</span></h4><ul><li><span>Gzip loading is now done via an internal zlib implementation.</span>
<span>This shaves off some 10-20% of load times for big .gz files, and there is no need for searching for an gzip.exe.</span></li><li><span>Extra view-as mode: auto.</span>
<span>Content type of a line will be detected and the line will be formatted using this content type.</span></li><li><span>Searching of terms in the detail view</span></li><li><span>Revamp of the detail view UI</span></li><li><span>Bugfixes</span></li></ul><h4><a name="v0914-jun-2019" class="md-header-anchor"></a><span>V0.914 (jun 2019)</span></h4><ul><li><span>When loading files with big lines, the lines are splitted in smaller, partial lines. By default, the size of a partial line is 2048.</span></li><li><span>Very big lines (above currently 10MB) will be truncated in the detail view.</span></li><li><span>Detail view is more stable during loading of a file. Partial loads are propagated to the detail view and a view disconnects itself when the logfile is closed</span></li><li><span>Bugfixes</span></li></ul><h4><a name="v0913" class="md-header-anchor"></a><span>V0.913</span></h4><ul><li><span>Loading of zip entries is implemented</span></li><li><span>Export functionality implemented</span></li><li><span>Bugfixes</span></li></ul><h4><a name="v0912" class="md-header-anchor"></a><span>V0.912</span></h4><ul><li><span>Bugfixes</span></li><li><span>Limited support for loading zip files</span></li><li><span>The detail view for a line is reusing the window. Also csv-view.</span></li><li><span>Recent files/folders are administrated</span></li><li><span>Faster startup</span></li><li><span>Shell extensions</span></li></ul></div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion help.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# BigFile (V0.9.3)
[toc]

BigFile is meant as a viewer for large files on Windows. Like 'less' on Unix systems.
The following provides a brief help guide for the core operations of BigFile.
Expand Down Expand Up @@ -153,6 +152,7 @@ The 1st parameter is the file or directory to be opened. If the parameter indica
#### V0.93 (may 2020)
- Gzip saving of export files is supported.
- More (de-)selection possibilities. Selections are now handled by the logfile itself, since the ListView was way too slow.
- Line view supports expansion of json, if the json contained strings with encoded json.
- Bugfixes.

#### V0.92 (feb 2020)
Expand Down

0 comments on commit ff8d2e2

Please sign in to comment.