Permalink
Browse files

major manpage doc overhaul

- cmdlog renamed to commandlog in most instances
- Remove support/test for Python 3.3
  • Loading branch information...
anjakefala authored and saulpw committed Sep 11, 2017
1 parent 480cd68 commit d4a96269623ed019af13076c3f0804383bd77957
View
@@ -7,7 +7,7 @@ A terminal interface for exploring and arranging tabular data.
## Dependencies
- OS/X or Linux
- Python 3.3+
- Python 3.4+
- other modules are required for opening particular filetypes
# Install
View
8 bin/vd
@@ -1,7 +1,7 @@
#!/usr/bin/env python3
#
# Usage: $0 [-d] [-r] [-f <filetype>] [<visidata options>] [<input_source> ...]
# $0 [-d] [-r] [-f <filetype>] [<visidata options>] [--piano] --play <commandlog.vd> [--foo=value ...]
# $0 [-d] [-r] [-f <filetype>] [<visidata options>] [--piano] --play <cmdlog.vd> [--foo=value ...]
__version__ = 'saul.pw/VisiData v0.97pre'
@@ -14,7 +14,7 @@ def eval_vd(logpath, *args, **kwargs):
log = logpath.read_text().format(*args, **kwargs)
src = PathFd(logpath.fqpn, io.StringIO(log))
vs = openSource(src)
vd().cmdlog.openHook(vs, src)
vd().commandlog.openHook(vs, src)
vd().push(vs)
vs.vd = vd()
return vs
@@ -28,7 +28,7 @@ def main():
parser.add_argument('-d', dest='debug', action='store_true', default=False, help='abort on error')
parser.add_argument('-r', dest='readonly', action='store_true', default=False, help='disable editing')
parser.add_argument('-f', dest='filetype', default='', help='specify file type')
parser.add_argument('-y', dest='confirm_overwrite', default=True, action='store_false', help='specify file type')
parser.add_argument('-y', dest='confirm_overwrite', default=True, action='store_false', help='sets confirm_overwrite option to false')
parser.add_argument('-p', '--play', dest='play', default=None, help='.vd file to replay')
for optname, v in vdtui.baseOptions.items():
@@ -68,7 +68,7 @@ def main():
sources = []
for src in inputs:
vs = openSource(src)
vdtui.vd().cmdlog.openHook(vs, src)
vdtui.vd().commandlog.openHook(vs, src)
sources.append(vs)
vdtui.run(sources)
View
@@ -1,6 +1,6 @@
machine:
post:
- pyenv global 3.3.6 3.4.4 3.5.3
- pyenv global 3.4.4 3.5.3
test:
override:
View
@@ -344,7 +344,7 @@ display error messages (without traceback) on the left side of the status bar.
Hooks
-----
Hooks for special functionality are stored in ``VisiData.hooks`` and supported with ``VisiData.addHook`` and ``VisiData.callHook``. At the moment, hooks are used mainly in ``editText``, the optional ``cmdlog`` addon, and before redrawing the screen.
Hooks for special functionality are stored in ``VisiData.hooks`` and supported with ``VisiData.addHook`` and ``VisiData.callHook``. At the moment, hooks are used mainly in ``editText``, the optional ``commandlog`` addon, and before redrawing the screen.
Adding a new data source
View
@@ -66,7 +66,7 @@
Shift- A
Shift- B clip'B'oard sheet
Shift- C 'C'olumns sheet
Shift- D cmdlog sheet
Shift- D commandlog sheet
Shift- E
Shift- F 'F'requency sheet
Shift- G move to bottom row [vim]
View
@@ -35,7 +35,7 @@ or clone from git
Dependencies
~~~~~~~~~~~~
- Python 3.3+
- Python 3.4+
- h5py and numpy (if opening .hdf5 files)
**Remember to install the Python3 versions of these packages with e.g.
View
@@ -0,0 +1,23 @@
.Sh Glossary
.
.Bl -tag -width XXXXXXXXX -compact
.It Ql abort
exit program immediately
.It Ql drop
drop top (current) sheet
.It Ql go
move cursor
.It Ql jump
change to existing sheet
.It Ql load
reload an existing sheet from in-memory contents
.It Ql move
change layout of visible data
.It Ql open
push a sheet to top of sheets list (making it immediately visible)
.It Ql scroll
change set of visible rows
.It Ql show
output to status line
.It Ql this
current [row/column/cell] ('current' is also used)
@@ -19,8 +19,8 @@
print(vd.__version__)
options_cli_skel = '''.It Sy --{cli_optname} Ar {type}
{description} (default '{default}')
options_cli_skel = '''.It Sy --{cli_optname} Ns ={type}
.No {description} (default Sy {default} Ns )
'''
options_menu_skel = '''.It Sy "{optname:<18}" No "{default:<16}"
View
@@ -0,0 +1,62 @@
.It Sy --debug Ns =bool
.No abort on error and display stacktrace (default Sy False Ns )
.It Sy --readonly Ns =bool
.No disable saving (default Sy False Ns )
.It Sy --encoding Ns =str
.No as passed to codecs.open (default Sy utf-8 Ns )
.It Sy --encoding-errors Ns =str
.No as passed to codecs.open (default Sy surrogateescape Ns )
.It Sy --curses-timeout Ns =int
.No curses timeout in ms (default Sy 100 Ns )
.It Sy --default-width Ns =int
.No default column width (default Sy 20 Ns )
.It Sy --regex-flags Ns =str
.No flags to pass to re.compile() [AILMSUX] (default Sy I Ns )
.It Sy --num-colors Ns =int
.No force number of colors to use (default Sy 0 Ns )
.It Sy --textwrap Ns =bool
.No wrap text to fit window width on TextSheet (default Sy True Ns )
.It Sy --cmd-after-edit Ns =str
.No command keystroke to execute after successful edit (default Sy j Ns )
.It Sy --aggr-null-filter Ns =str
.No invalid values to filter out when aggregating: (n/e/f/"") (default Sy none Ns )
.It Sy --float-chars Ns =str
.No valid numeric characters (default Sy +-0123456789.eE_ Ns )
.It Sy --profile-tasks Ns =bool
.No profile async tasks (default Sy True Ns )
.It Sy --min-task-time-s Ns =float
.No only keep tasks that take longer than this number of seconds (default Sy 0.1 Ns )
.It Sy --min-memory-mb Ns =int
.No stop loading and async processing unless this much memory is available (default Sy 0 Ns )
.It Sy --confirm-overwrite Ns =bool
.No whether to prompt for overwrite confirmation on save (default Sy True Ns )
.It Sy --headerlines Ns =int
.No parse first N rows of .csv/.tsv as column names (default Sy 1 Ns )
.It Sy --skiplines Ns =int
.No skip first N lines of text input (default Sy 0 Ns )
.It Sy --filetype Ns =str
.No specify file type (default Sy Ns )
.It Sy --histogram-bins Ns =int
.No number of bins for histogram of numeric columns (default Sy 0 Ns )
.It Sy --histogram-even-interval Ns =bool
.No if histogram bins should have even distribution of rows (default Sy False Ns )
.It Sy --pyobj-show-hidden Ns =bool
.No show methods and _ properties (default Sy False Ns )
.It Sy --melt-var-colname Ns =str
.No column name to use for the melted variable name (default Sy Variable Ns )
.It Sy --melt-value-colname Ns =str
.No column name to use for the melted value (default Sy Value Ns )
.It Sy --piano Ns =float
.No --play piano delay in seconds (default Sy 0.0 Ns )
.It Sy --regex-maxsplit Ns =int
.No maxsplit to pass to regex.split (default Sy 0 Ns )
.It Sy --csv-dialect Ns =str
.No dialect passed to csv.reader (default Sy excel Ns )
.It Sy --csv-delimiter Ns =str
.No delimiter passed to csv.reader (default Sy , Ns )
.It Sy --csv-quotechar Ns =str
.No quotechar passed to csv.reader (default Sy " Ns )
.It Sy --csv-skipinitialspace Ns =bool
.No skipinitialspace passed to csv.reader (default Sy True Ns )
.It Sy --fixed-rows Ns =int
.No number of rows to check for fixed width columns (default Sy 1000 Ns )
Oops, something went wrong.

0 comments on commit d4a9626

Please sign in to comment.