nb

simple notebook manager
git clone git@getsh.org:nb.git
Log | Files | Refs | README | LICENSE

nb.1 (967B)


      1 .Dd October 06, 2021
      2 .Dt NB 1
      3 .Os
      4 .Sh NAME
      5 .Nm nb
      6 .Nd simple notebook manager
      7 .Sh SYNOPSIS
      8 .Nm
      9 .Op n|new
     10 .Ar file_name.md
     11 .Nm
     12 .Op s|sync
     13 .Sh DESCRIPTION
     14 The
     15 .Nm
     16 provides a lightweight interface for accessing and adding notes on command line.
     17 .Pp
     18 .Nm
     19 doesn't complain much and tries to work with what is available.
     20 .Xr fzf 1
     21 is used for fuzzy searching and it is launched by default if no options are given.
     22 .Pp
     23 In the case of fzf unavailability,
     24 .Nm
     25 simply changes directory to NB_PATH
     26 .Pp
     27 If
     28 .Op sync
     29 option is used,
     30 .Nm
     31 attempts a add/commit/push cycle on NB_PATH via
     32 .Xr git 1
     33 .Sh ENVIRONMENT
     34 .Bl -hang -width "NB_PATH"
     35 .It Ev NB_PATH
     36 The location of your notebook folder.
     37 .El
     38 .Sh AUTHORS
     39 .An Bharatvaj Aq Mt bharatvaj@getsh.org
     40 .Sh LICENSE
     41 .Nm
     42 is in the public domain.
     43 .Pp
     44 To the extent possible under law,
     45 the creator of this work
     46 has waived all copyright and related or
     47 neighboring rights to this work.
     48 .Pp
     49 .Lk http://creativecommons.org/publicdomain/zero/1.0/