gawk

Sed-like interface to the Gopher protocol
git clone git://jacobedwards.org/gawk
Log | Files | Refs | LICENSE

gawk.1 (2284B)


      1 .de NN
      2 .PP
      3 .BR \\$1 \" display full name [ \\$2 ]
      4 ..
      5 .de II
      6 .br
      7 ..
      8 .TH GAWK 1 2020.12.21
      9 .SH NAME
     10 .B gawk
     11 \(em gawk at gopherholes
     12 .SH SYNOPSIS
     13 .B gawk
     14 .RI [ path
     15 .RI [ host
     16 .RI [ port ]]]
     17 .SH DESCRIPTION
     18 .B gawk
     19 is a gopher (see
     20 .BR STANDARDS )
     21 client which uses filtering instead of navigation making for a
     22 pleasant interface.
     23 .SH USAGE
     24 .SS Syntax
     25 .PP
     26 Statements are separated by semi-colen `;' and newline `\\n'.
     27 Statement commands are separated by bar `|'.  Command arguments are
     28 separated by space ` ' and tab `\\t'.
     29 .PP
     30 If a statement consists of multiple commands this forms a pipeline,
     31 each command will either pass or skip it's input item, if a command
     32 is negated by prefixing it's name with an exclamation point `!'
     33 this effect is reversed.
     34 .IP
     35 .B note:
     36 Only item commands (see below) can form a pipeline.
     37 .SS
     38 Commands
     39 .NN "G" "oto"
     40 .RI [ path " [" host " [" port ]]]
     41 .II
     42 Go to the location specified by it's arguments, lacking arguments
     43 are replaced by their current values.
     44 .NN "q" "uit"
     45 .II
     46 Equivalent to
     47 .I u
     48 with an argument of the current depth.
     49 .NN "u" "nwind"
     50 .BA n
     51 .II
     52 Unwind the stack by
     53 .IR n .
     54 .SS
     55 Item commands
     56 .NN "P" "rint"
     57 .II
     58 Wrapper around the `p' command which writes extra information about
     59 each item.
     60 .NN "e" "xtern"
     61 .I program
     62 .RI [ argument... ]
     63 .II
     64 Run
     65 .I program
     66 in the background with each argument consisting of solely `%'
     67 replaced by
     68 .IR host / path .
     69 .NN "f" "etch"
     70 .RI [ path ]
     71 .II
     72 Fetch each input item to
     73 .I path
     74 or, if lacking, the basename of the remote path.
     75 .NN "g" "oto"
     76 .RI [ query ]
     77 .II
     78 Go to the location specified by it's input item, if the item is of
     79 type 7 the op
     80 .NN "i" "ndex"
     81 .I n...
     82 .II
     83 Only pass items with an index matching one of the given indexes,
     84 .IR n .
     85 .NN "p" "rint"
     86 .II
     87 The `p' command formats it's input writing it to stdout.
     88 .NN "r" "ange"
     89 .RI ( "low high" )...
     90 .II
     91 Only pass items with an index within one of the ranges
     92 .IR low - high .
     93 .NN "s" "tring"
     94 .I substring...
     95 .II
     96 Only pass items if their info field gets matched by all
     97 .I substring
     98 arguments.
     99 .NN "t" "ype"
    100 .I types
    101 .II
    102 Pass items if their type is one of the types listed in
    103 .IR types .
    104 .SH CONFIGURATION
    105 Configuration is done by creating a costom config.h and (re)compiling
    106 the source code.
    107 .SH STANDARDS
    108 .I Internet RFC 1436
    109 .SH AUTHOR
    110 Jacob R. Edwards