Skip to content

Commit

Permalink
Migrate "Other" wiki page from Bitbucket
Browse files Browse the repository at this point in the history
Issue: #175
  • Loading branch information
mlopatkin committed Dec 31, 2023
1 parent 6a281fe commit bd74cc8
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 94 deletions.
99 changes: 5 additions & 94 deletions docs/site/content/_index.en.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,97 +14,8 @@ live from a device or an emulator, or log and dumpstate files.
* [Filter log lines by tag, PID, log priority, message content](/filters)
* Filtered lines can be hidden, highlighted or shown in a separate window
* [Search in the logs using regex if needed](/search)
* Bookmarks
* Display any avaliable buffers: main, system, events, radio
* Save filtered lines
* Display process list


<!--## Features
- Display logs from a device or an emulator
- Display saved logs and dumpstate files
- Search in the logs using regex if needed
- Bookmarks
- Filter log lines by tag, PID, app name, log priority, message content
- Filtered lines can be hidden, highlighted or shown in a separate window
- Display any avaliable buffers: main, system, events, radio
- Save filtered lines
- Display process list
## Installing
Requirements:
- JRE 8+
- Android SDK (to work with a device or an emulator)
Unpack a zip archive to any folder.
Use the OS-specific script to launch AndLogView:
- `bin/andlogview.bat` (Windows)
- `bin/andlogview` (Linux)
Both scripts expect the javaw/java to be on your PATH.
## Overview: filters
The following filtering criteria are supported:
- Tag(s)
- Message text
- PID(s) and/or application name(s)
- Log priority
Filtered lines can be:
- Showed (all other lines will be hidden)
- Hidden
- Highlighted
- Showed in a separate window
You may enter several tags, application names or PIDs separated with commas, any
of them will be filtered. Message, tag and application name filters support
regular expressions. If several criteria are specified, only records that
match all of them will be filtered. If the tag or application name contain `,`
then `,` symbol should be doubled or the whole pattern should be enclosed in
backticks. For example, if you want to search for tags `Foo,bar` and `Bar,baz`
you should enter `Foo,,bar, Bar,,baz` or `` `Foo,bar`, `Bar,baz` ``. Wrapping
in backticks doesn't work for regular expressions.
## Overview: searching
1. `Ctrl+F` - show search field
2. Enter the pattern, then press `Enter` to start searching
3. `F3` - find next, `Shift+F3` - find previous
4. `Esc` - clear search results
You should wrap your pattern into `/.../` - slashes - to search using regular
expressions, ex. `/^[Aa].*$/` - all lines that start with lower or upper 'a'.
Regex-based searching is case-sensitive in opposite to a simple searching.
Standard Java regular expression syntax is used.
Searching is performed in application name, tag and message fields. You can
limit search scope to the single field by prefixing search request with `app:`,
`tag:`, or `msg:` respectively. Only one (first) prefix is in effect, others are
treated like normal search pattern.
## Overview: other
- The bookmarks windows can be used for quick jumping between marked lines.
Use context menu to add a line to bookmarks.
- You can copy log lines to the clipboard using `Ctrl+C`, `Ctrl+Ins` or the
context menu.
- Double-click on tag, message or pid cell opens edit mode where you can
select and copy a substring of the cell's content
See the complete manual at https://bitbucket.org/mlopatkin/android-log-viewer/wiki
## Contacts
There is a mailing list [android-log-viewer at Google Groups](https://groups.google.com/forum/#!forum/android-log-viewer)
for release announcements and discussions.
Please report bugs to https://github.com/mlopatkin/andlogview/issues
-->
* [Bookmarks](/other/#bookmarks)
* [Display any avaliable logcat buffers: main, system, events, radio, crash,
kernel](/other/#buffer-types)
* [Save filtered lines](/other/#saving-files)
* [Display process list](/other/#processes-list)
73 changes: 73 additions & 0 deletions docs/site/content/other/_index.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
---
title: Other features
weight: 40
---

{{< toc >}}

## Bookmarks

The bookmarks windows can be used for quick jumping between marked lines.

Right-click on the line and select "Add to bookmarks" to add the line to
bookmarks. Bookmarked lines are highlighted with dark blue background:

![Bookmarks](bookmarks.png)

Double-click on the line in the bookmark window to scroll the main window to it.

To remove one or several lines from bookmarks select them and press
<kbd><kbd>Del</kbd></kbd> or use "Remove from bookmarks" command of the context
menu.

The bookmark windows opens when a line is added to bookmarks or with a
"View > Show bookmarks" command in the main menu.

## Buffer types

The Android logging system contains several logging buffers:
`main`, `radio`, `events`, `system`, `crash`, `kernel`, and `security`. Not all
buffers are available on all Android versions.

If the information about source buffer of the line is available you can use
filtering by buffer type: check interesting buffers in the "Buffers" menu.

![Buffer selector menu](buffer_selector.png)

{{< hint type=warning >}}
Security buffer is not yet supported by AndLogView.
{{< /hint >}}

## Saving files

All lines that passes filters will be saved when you select "File > Save".
Actual format of the resulting file depends of the log verbosity:
* brief, if only pid, priority, tag and message are known
* time, if the time is known too
* threadtime, if the tid is known too

## Processes list

If an information about the running processes is available (you're viewing
logs from a device, emulator, or a dumpstate file) then you can see it in the
"Processes" window. Use "View > Show processes" command in the main menu to
open the window.

![Processes list](processes.png)

This window displays all processes that are known to the tool including already
terminated ones. You can clear the list from terminated processes with
"ADB > Reset logs" (this will clear the logs too).

## Clipboard

Your can copy selected log lines using "Copy row" from the context menu or
<kbd><kbd>Ctrl</kbd><kbd>C</kbd></kbd> or
<kbd><kbd>Ctrl</kbd><kbd>Ins</kbd></kbd>.

Double-clicking on PID, TID, tag or message fields enables edit mode and you can
select some text in the field and copy it to the cliboard with
<kbd><kbd>Ctrl</kbd><kbd>C</kbd></kbd> or
<kbd><kbd>Ctrl</kbd><kbd>Ins</kbd></kbd>

This works in all log windows and in the process list.
Binary file added docs/site/content/other/bookmarks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/content/other/buffer_selector.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/site/content/other/processes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bd74cc8

Please sign in to comment.