insert-iod-key - Insert a key to IOD configuration file
This document describes version 0.162 of insert-iod-key (from Perl distribution App-IODUtils), released on 2019-01-17.
Basic usage:
% insert-iod-key /path/to/file.iod section key value
* marks required options.
*
When key already exists, add.
When section does not exist, create it first.
When key already exists, do nothing.
Modify file in-place.
Note that this can only be done if you specify an actual file and not STDIN. Otherwise, an error will be thrown.
Put key line at a specific line number (line number starts from 1).
When key already exists, delete previous key(s) first.
Add to the beginning of section instead of end.
(Raw) value.
Choose output format, e.g. json, text.
Default value:
undef
Set output format to json.
When outputing as JSON, strip result envelope.
0
By default, when outputing as JSON, the full enveloped result is returned, e.g.:
[200,"OK",[1,2,3],{"func.extra"=>4}]
The reason is so you can get the status (1st element), status message (2nd element) as well as result metadata/extra result (4th element) instead of just the result (3rd element). However, sometimes you want just the result, e.g. when you want to pipe the result for more post-processing. In this case you can use `--naked-res` so you just get:
[1,2,3]
Can be specified multiple times.
See --allow-directive.
--allow-directive
See --allow-encoding.
--allow-encoding
"GLOBAL"
See --disallow-directive.
--disallow-directive
See --disallow-encoding.
--disallow-encoding
Each value is a name-value pair, use key=value syntax. Can be specified multiple times.
See --expr-var.
--expr-var
Display help message and exit.
IOD file.
Display program's version and exit.
This script has shell tab completion capability with support for several shells.
To activate bash completion for this script, put:
complete -C insert-iod-key insert-iod-key
in your bash startup (e.g. ~/.bashrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is recommended, however, that you install modules using cpanm-shcompgen which can activate shell completion for scripts immediately.
To activate tcsh completion for this script, put:
complete insert-iod-key 'p/*/`insert-iod-key`/'
in your tcsh startup (e.g. ~/.tcshrc). Your next shell session will then recognize tab completion for the command. Or, you can also directly execute the line above in your shell to activate immediately.
It is also recommended to install shcompgen (see above).
For fish and zsh, install shcompgen as described above.
Please visit the project's homepage at https://metacpan.org/release/App-IODUtils.
Source repository is at https://github.com/perlancar/perl-App-IODUtils.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=App-IODUtils
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2019, 2017, 2016, 2015, 2014 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install App::IODUtils, copy and paste the appropriate command in to your terminal.
cpanm
cpanm App::IODUtils
CPAN shell
perl -MCPAN -e shell install App::IODUtils
For more information on module installation, please visit the detailed CPAN module installation guide.