hddb.1

   1 .TH HDDB 1 hddb\-1.0.0
   2 .SH NAME
   3 hddb \- the simple Haskell Document Database
   4 .SH SYNOPSIS
   5 .B hddb
   6 .RB <operation>\ [options]
   7 .SH DESCRIPTION
   8 hddb is a simple sqlite-powered document tracker written in Haskell, with a
   9 command-line interface.
  10 .P
  11 It allows the user to track documents in a database along with metadata:
  12 full absolute path, title, authors, keywords, journal, volume,
  13 year of publication, and pages.
  14 .P
  15 The database can be queried using any piece of metadata, or by specifying
  16 the document's unique numeric id.
  17 .SH OPERATIONS
  18 .TP
  19 .B add
  20 add a document to the database
  21 .TP
  22 .B remove
  23 remove a document from the database
  24 .TP
  25 .B modify
  26 modify a database entry
  27 .TP
  28 .B search
  29 search entries in the database
  30 .TP
  31 .B view
  32 see a tracked document in a viewer
  33 .TP
  34 .B help
  35 prints a help message
  36 .TP
  37 .B version
  38 prints the version
  39 .SH USAGE
  40 .SS add <filters>
  41 .TP
  42 .B -f <file>
  43 specify the document path.
  44 .TP
  45 .B -t <title>
  46 specify the document title.
  47 .TP
  48 .B -a <author1> [<author2> ...]
  49 specify the authors list.
  50 .TP
  51 .B -k <keyword1> [<keyword2> ...]
  52 specify the keywords list.
  53 .TP
  54 .B -j <journal>
  55 specify the journal.
  56 .TP
  57 .B -y <year>
  58 specify the year of publication. The format is YYYY.
  59 .TP
  60 .B -p <page> [page]
  61 specify the page, or range of pages.
  62 .SS remove <id>
  63 .B WARNING: no undo!
  64 .SS modify <id> <filters>
  65 .B WARNING: no undo!
  66 .TP
  67 .B -f <file>
  68 specify the new document path.
  69 .TP
  70 .B -t <title>
  71 specify the new document title.
  72 .TP
  73 .B -a +<author to add> <author to remove> ...
  74 specify changes to the authors list.
  75 .TP
  76 .B -k +<keyword to add> <keyword to remove> ...
  77 specify changes to the keywords list.
  78 .TP
  79 .B -j <journal>
  80 specify the new journal.
  81 .TP
  82 .B -y <year>
  83 specify the new year of publication. The format is YYYY.
  84 .TP
  85 .B -p <page> [page]
  86 specify the new page, or range of pages.
  87 .SS search [id]
  88 .B search without arguments prints the full content of the database. When given an id, it prints the content of the corresponding entry.
  89 .SS search <filters>
  90 .B prints the matching entries.
  91 .TP
  92 .B -f <file>
  93 specify the document path.
  94 .TP
  95 .B -t <title>
  96 specify the document title.
  97 .TP
  98 .B -a <author1> [<author2> ...]
  99 specify the authors list.
 100 .TP
 101 .B -k <keyword1> [<keyword2> ...]
 102 specify the keywords list.
 103 .TP
 104 .B -j <journal>
 105 specify the journal.
 106 .TP
 107 .B -y <year>
 108 specify the year of publication. The format is YYYY.
 109 .TP
 110 .B -p <page> [page]
 111 specify the page, or range of pages.
 112 .SS view <id> [-v <viewer>]
 113 .B if used without <-v>, launches default viewer.
 114 .SH BUGS
 115 Please report any bugs at https://github.com/gagnonlg/hddb