# fmark

**Repository Path**: rkikbs/fmark

## Basic Information

- **Project Name**: fmark
- **Description**: Mozilla Firefox 的书签管理工具，测试书签连接状态，列出/删除重复书签及优化书签数据库等功能。
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2015-03-10
- **Last Updated**: 2020-12-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# fmark

[中文版](README_zhCN.md)

A bookmark management application for Mozilla Firefox.

## Requirements

### Bash

fmark is written by shell script language, therefore Bash has to be
installed with your operating system.

If you are running fmark in \*nix systems like Linux and Mac OS X,
no worries probably you already have Bash installed. Windows is not
natively supported, however you can try to install Bash with [Cygwin].

### Firefox 3 or later

Starting in version 3, [Mozilla Firefox] stores bookmarks in a SQLite
file named "places.sqlite" in the profile directory, which means you
should have this file for bookmark management by fmark.

### SQLite command-line tool

The `sqlite3` command-line tool is needed for fmark to manage the
bookmarks in database. See more details at [SQLite Official Website].

## Installation

Run the "install.sh" program at the top of this repository.

```bash
$ ./install.sh [--prefix=PREFIX] [--tag=TAG] [--help]
```

*--prefix=PREFIX*

Replace PREFIX with the filesystem path under which fmark should be
installed. By default, installer will use "/usr/local" for PREFIX
(without the quotes).

*--tag=TAG*

TAG of commit fmark should be installed with. This option is only
available if you are running the installer within a git repository.

## Uninstallation

To uninstall fmark, run "uninstall.sh" program.

```bash
$ ./uninstall.sh [--prefix=PREFIX] [--help]
```

The uninstaller will grab the PREFIX path of your latest installation
from "install.log". Of course, you can specify this option manually.

## Commands

Most of the commands are available with two options as beneath.

*--dbfile=DBFILE*

You can specify the database file path with this option, or else
fmark will try to find the path from the configuration file.

*--help*

Show the help messages of this command and exit.

### list

Lists bookmarks in Mozilla Firefox

```bash
$ fmark list [--cols=COLS] [--duplicate=COL] [--delimiter=DELM] [--omitone] [--dbfile=DBFILE] [--help]
```

*--cols=COLS*

Flags represent bookmark columns to be listed. The flags can be:

- i = ID
- u = URL
- t = Title
- a = Date Added
- m = Last Modified
- k = Keyword
- d = Description
- c = Visit Count
- l = Last Visit Date
- g = Tags

*--duplicate=COL*

If specified, fmark only lists bookmarks duplicated with COL:

- u = URL
- t = Title

*--delimiter=DELIM*

Use DELIM as the field delimiter, a TAB by default. If you'd like to use
some speicial character like "$" or "&", which have some particular
functionalities. You have to escape them of course.

*--omitone*

Use this option ONLY with *--duplicate*, to omit the first duplicate.

### op

Optimizes bookmark database,
see [more details](http://www.sqlite.org/lang_vacuum.html).

```bash
$ fmark op [--dbfile=DBFILE] [--help]
```

### test

Tests connection and HTTP status of bookmarks.

```bash
$ fmark test [--max-time=SECONDS] [--threads=NUM] [--dbfile=DBFILE]
[--help]
```

*--max-time=SECONDS*

Maximum time in seconds operation to take, defaults to be 5

*--threads=NUM*

Number of multiple requests to make, defaults to be 10

Example:

```bash
$ fmark test
[200] http://www.gnu.org
[200] http://www.yahoo.com
[ERR] http://www.youtube.com       // I'm in China, so you know why
```

### rm

Removes bookmarks by identifiers.

```bash
$ fmark rm [ID [...]] [--dbfile=DBFILE] [--help]
```

If no identifiers specified with arguments, this command will read the
identifiers from STDIN(0).

Example:

```bash
$ fmark list --duplicate=u --cols=i --omitone | fmark rm
```

This command remains one bookmarks from each duplicated groups,
and removes others.

## License

Copyright (C) 2015 Yaowen HE

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

[Mozilla Firefox]: http://www.mozilla.org/firefox/
[Cygwin]: http://www.cygwin.com
[SQLite Official Website]: http://www.sqlite.org