neulab/tldr huggingface dataset:
tox-pipenv (1.4.1)                   - A pipenv plugin for tox tox-pyenv (1.1.0)                    - tox plugin that makes tox use ``pyenv which`` to find python executables tox-globinterpreter (0.3)            - tox plugin to allow specification of interpreter locationspaths to use tox-venv (0.2.0)                     - Use python3 venvs for python3 tox testenvs tox-cmake (0.1.1)                    - Build CMake projects using tox tox-travis (0.10)                    - Seamless integration of tox into Travis CI tox-py-backwards (0.1)               - tox plugin for py-backwards tox-pytest-summary (0.1.2)           - tox + Py.test summary tox-envreport (0.2.0)                - A tox-plugin to document the setup of used virtual environments. tox-no-internet (0.1.0)              - Workarounds for using tox with no internet connection tox-virtualenv-no-download (1.0.2)   - Disable virtualenv's download-by-default in tox tox-run-command (0.4)                - tox plugin to run arbitrary commands in a virtualenv tox-pip-extensions (1.2.1)           - Augment tox with different installation methods via progressive enhancement. tox-run-before (0.1)                 - tox plugin to run shell commands before the test environments are created. tox-docker (1.0.0)                   - Launch a docker instance around test runs tox-bitbucket-status (1.0)           - Update bitbucket status for each env tox-pipenv-install (1.0.3)           - Install packages from Pipfile
There might also be some plugins not (yet) available from PyPI that could be installed directly fom source hosters like Github or Bitbucket (or from a local clone). See the
To see what is installed you can call tox --version to get the version of the host and names and locations of all installed plugins:
3.0.0 imported from /home/ob/.virtualenvs/tmp/lib/python3.6/site-packages/tox/__init__.py registered plugins: tox-travis-0.10 at /home/ob/.virtualenvs/tmp/lib/python3.6/site-packages/tox_travis/hooks.py
Creating a plugin Start from a template
You can create a new tox plugin with all the bells and whistles via a Cookiecutter template (see cookiecutter-tox-plugin - this will create a complete PyPI-releasable, documented project with license, documentation and CI.
$ pip install -U cookiecutter $ cookiecutter gh:tox-dev/cookiecutter-tox-plugin
Tutorial: a minimal tox plugin NOTE: This is the minimal implementation to demonstrate what is absolutely necessary to have a working plugin for internal use. To move from something like this to a publishable plugin you could apply cookiecutter -f cookiecutter-tox-plugin and adapt the code to the package based structure used in the cookiecutter.
Let us consider you want to extend tox behaviour by displaying fireworks at the end of a successful tox run (we won't go into the details of how to display fireworks though).
To create a working plugin you need at least a python project with a tox entry point and a python module implementing one or more of the pluggy based hooks tox specifies (using the @tox.hookimpl decorator as marker).
minimal structure:
$ mkdir tox-fireworks $ cd tox-fireworks $ touch tox_fireworks.py $ touch setup.py
contents of tox_fireworks.py:
import pluggy
hookimpl = pluggy.HookimplMarker("tox")
@hookimpl def tox_addoption(parser): """Add command line option to display fireworks on request."""
@hookimpl def tox_configure(config): """Post process config after parsing."""
@hookimpl def tox_runenvreport(config): """Display fireworks if all was fine and requested."""
NOTE: See Hook specifications and related API for details
contents of setup.py:
from setuptools import setup
setup( name="tox-fireworks", py_modules=["tox_fireworks"], entry_points={"tox": ["fireworks = tox_fireworks"]}, classifiers=["Framework:: tox"], )
Using the  tox- prefix in tox-fireworks is an established convention to be able to see from the project name that this is a plugin for tox. It also makes it easier to find with e.g. pip search 'tox-' once it is released on PyPI.
To make your new plugin discoverable by tox, you need to install it. During development you should install it with -e or --editable, so that changes to the code are immediately active:
$ pip install -e </path/to/tox-fireworks>
Publish your plugin to PyPI If you think the rest of the world could profit using your plugin you can publish it to PyPI.
You need to add some more meta data to setup.py (see cookiecutter-tox-plugin for a complete example or consult the setup.py docs).
NOTE: Make sure your plugin project name is prefixed by tox- to be easy to find via e.g.  pip search tox-
You can and publish it like:
$ cd </path/to/tox-fireworks> $ python setup.py sdist bdist_wheel upload
NOTE: You could also use twine for secure uploads.
For more information about packaging and deploying Python projects see the Python Packaging Guide.
Hook specifications and related API Hook specifications for tox - see https://pluggy.readthedocs.io/
tox.hookspecs.tox_addoption(parser) add command line options to the argparse-style parser object.
tox.hookspecs.tox_configure(config) Called after command line options are parsed and ini-file has been read.
Please be aware that the config object layout may change between major tox versions.
tox.hookspecs.tox_get_python_executable(envconfig) Return a python executable for the given python base name.
The first plugin/hook which returns an executable path will determine it.
envconfig is the testenv configuration which contains per-testenv configuration, notably the .envname and .basepython setting.
tox.hookspecs.tox_package(session, venv) Return the package to be installed for the given venv.
Called once for every environment.
tox.hookspecs.tox_runenvreport(venv, action) Get the installed packages and versions in this venv.
This could be used for alternative (ie non-pip) package managers, this plugin should return a list of type str
tox.hookspecs.tox_runtest(venv, redirect) Run the tests for this venv.
NOTE: This hook uses firstresult=True (see pluggy first result only) -- hooks implementing this will be run until one returns non-None.
tox.hookspecs.tox_runtest_post(venv) Perform arbitrary action after running tests for this venv.
This could be used to have per-venv test reporting of pass/fail status.
tox.hookspecs.tox_runtest_pre(venv) Perform arbitrary action before running tests for this venv.
This could be used to indicate that tests for a given venv have started, for instance.
tox.hookspecs.tox_testenv_create(venv, action) Perform creation action for this venv.
Some example usage:
• To add behavior but still use tox's implementation to set up a virtualenv, implement this hook but do not return a value (or explicitly return None).
• To override tox's virtualenv creation, implement this hook and return a non-None value.
NOTE: This api is experimental due to the unstable api of tox.venv.VirtualEnv.
tox.hookspecs.tox_testenv_install_deps(venv, action) Perform install dependencies action for this venv.
• To add behavior but still use tox's implementation to install dependencies, implement this hook but do not return a value (or explicitly return None).  One use-case may be to install (or ensure) non-python dependencies such as debian packages.
• To override tox's installation of dependencies, implement this hook and return a non-None value.  One use-case may be to install via a different installation tool such as pip-accel or pip-faster.
class tox.config.Parser Command line and ini-parser control object.
add_argument(*args, **kwargs) add argument to command line parser.  This takes the same arguments that argparse.ArgumentParser.add_argument.
add_testenv_attribute(name, type, help, default=None, postprocess=None) add an ini-file variable for "testenv" section.
Types are specified as strings like "bool", "line-list", "string", "argv", "path", "argvlist".
The postprocess function will be called for each testenv like postprocess(testenv_config=testenv_config, value=value) where value is the value as read from the ini (or the default value) and testenv_config is a tox.config.TestenvConfig instance which will receive all ini-variables as object attributes.
Any postprocess function must return a value which will then be set as the final value in the testenv section.
add_testenv_attribute_obj(obj) add an ini-file variable as an object.
This works as the add_testenv_attribute function but expects "name", "type", "help", and "postprocess" attributes on the object.
class tox.config.Config Global Tox config object.
args = None option namespace containing all parsed command line options
envconfigs = None Mapping envname -> envconfig
class tox.config.TestenvConfig Testenv Configuration object.
In addition to some core attributes/properties this config object holds all per-testenv ini attributes as attributes, see "tox --help-ini" for an overview.
config = None global tox config object
envname = None test environment name
envpython Path to python executable.
factors = None set of factors
get_envbindir() Path to directory where scripts/binaries reside.
get_envpython() path to python/jython executable.
get_envsitepackagesdir() Return sitepackagesdir of the virtualenv environment.
NOTE: Only available during execution, not during parsing.
missing_subs = None Holds substitutions that could not be resolved.
Pre 2.8.1 missing substitutions crashed with a ConfigError although this would not be a problem if the env is not part of the current testrun. So we need to remember this and check later when the testenv is actually run and crash only then.
python_info Return sitepackagesdir of the virtualenv environment.
class tox.venv.VirtualEnv
getcommandpath(name, venv=True, cwd=None) Return absolute path (str or localpath) for specified command name.
• If it's a local path we will rewrite it as as a relative path.
• If venv is True we will check if the command is coming from the venv or is whitelisted to come from external.
name   test environment name.
path   Path to environment base dir.
update(action) return status string for updating actual venv to match configuration.  if status string is empty, all is ok.
class tox.session.Session The session object that ties together configuration, reporting, venv creation, testing.
getvenv(name) return a VirtualEnv controler object for the 'name' env.
installpkg(venv, path) Install package in the specified virtual environment.
• venv (VenvConfig) -- Destination environment
• path (str) -- Path to the distribution package.
Returns True if package installed otherwise False.
run_parallel() here we'll just start parallel sub-processes
runenvreport(venv) Run an environment report to show which package versions are installed in the venv
Developers FAQ This section contains information for users who want to extend the tox source code.
• PyCharm
• Multiple Python versions on Windows
PyCharm 1. To generate the project interpreter you can use tox -rvvve dev.
2. For tests we use pytest, therefore change the Default test runner to pytest.
3. In order to be able to debug tests which create a virtual environment (the ones in test_z_cmdline.py) one needs to disable the PyCharm feature Attach to subprocess automatically while debugging (because virtualenv creation calls via subprocess to the pip executable, and PyCharm rewrites all calls to Python interpreters to attach to its debugger - however, this rewrite for pip makes it to have bad arguments: no such option --port).
Multiple Python versions on Windows In order to run the unit tests locally all Python versions enlisted in tox.ini need to be installed.
NOTE: For a nice Windows terminal take a look at cmder.
One solution for this is to install the latest conda, and then install all Python versions via conda envs. This will create separate folders for each Python version.
conda create -n python2.7 python=2.7 anaconda
For tox to find them you'll need to:
• add the main installation version to the systems PATH variable (e.g. D:\Anaconda - you can use WindowsPathEditor)
• for other versions create a BAT scripts into the main installation folder to delegate the call to the correct Python interpreter:
@echo off REM python2.7.bat @D:\Anaconda\pkgs\python-2.7.13-1\python.exe %*
This way you can also directly call from cli the matching Python version if you need to(similarly to UNIX systems), for example:
python2.7 main.py python3.6 main.py
Writing a json result file You can instruct tox to write a json-report file via:
tox --result-json=PATH
This will create a json-formatted result file using this schema:
{ "testenvs": { "py27": { "python": { "executable": "/home/hpk/p/tox/.tox/py27/bin/python", "version": "2.7.3 (default, Aug  1 2012, 05:14:39) \n[GCC 4.6.3]", "version_info": [ 2, 7, 3, "final", 0 ] }, "test": [ { "output": "...", "command": [ "/home/hpk/p/tox/.tox/py27/bin/pytest", "--instafail", "--junitxml=/home/hpk/p/tox/.tox/py27/log/junit-py27.xml", "tests/test_config.py" ], "retcode": "0" } ], "setup": [] } }, "platform": "linux2", "installpkg": { "basename": "tox-1.6.0.dev1.zip", "sha256": "b6982dde5789a167c4c35af0d34ef72176d0575955f5331ad04aee9f23af4326", "md5": "27ead99fd7fa39ee7614cede6bf175a6" }, "toxversion": "1.6.0.dev1", "reportversion": "1" }
Less announcing, more change-logging With version 2.5.0 we dropped creating special announcement documents and rely on communicating all relevant changes through the CHANGELOG. See at PyPI for a rendered version of the last changes containing links to the important issues and pull requests that were integrated into the release.
The historic release announcements are still online here for various versions:
• 0.5,
• 1.0,
• 1.1,
• 1.2,
• 1.3,
• 1.4,
• 1.4.3,
• 1.8,
• 1.9,
• 2.0,
• 2.4.0.
Happy testing, The tox maintainers
holger krekel and others
2010-2019, holger krekel and others
SMBCLIENT(1)                      User Commands                     SMBCLIENT(1)
smbclient - ftp-like client to access SMB/CIFS resources on servers
smbclient [-M|--message=HOST] [-I|--ip-address=IP] [-E|--stderr] [-L|--list=HOST] [-T|--tar=<c|x>IXFvgbNan] [-D|--directory=DIR] [-b|--send-buffer=BYTES] [-t|--timeout=SECONDS] [-p|--port=PORT] [-g|--grepable] [-q|--quiet] [-B|--browse] [-?|--help] [--usage] [-d|--debuglevel=DEBUGLEVEL] [--debug-stdout] [-s|--configfile=CONFIGFILE] [--option=name=value] [-l|--log-basename=LOGFILEBASE] [--leak-report] [--leak-report-full] [-R|--name-resolve=NAME-RESOLVE-ORDER] [-O|--socket-options=SOCKETOPTIONS] [-m|--max-protocol=MAXPROTOCOL] [-n|--netbiosname=NETBIOSNAME] [--netbios-scope=SCOPE] [-W|--workgroup=WORKGROUP] [--realm=REALM] [-U|--user=[DOMAIN/]USERNAME%[PASSWORD]] [-N|--no-pass] [--password=STRING] [--pw-nt-hash] [-A|--authentication-file=FILE] [-P|--machine-pass] [--simple-bind-dn=DN] [--use-kerberos=desired|required|off] [--use-krb5-ccache=CCACHE] [--use-winbind-ccache] [--client-protection=sign|encrypt|off] [-V|--version] [-c|--command=STRING]
smbclient is a client that can 'talk' to an SMB/CIFS server. It offers an interface similar to that of the ftp program (see ftp(1)). Operations include things like getting files from the server to the local machine, putting files from the local machine to the server, retrieving directory information from the server and so on.
servicename servicename is the name of the service you want to use on the server. A service name takes the form //server/service where server is the NetBIOS name of the SMB/CIFS server offering the desired service and service is the name of the service offered. Thus to connect to the service "printer" on the SMB/CIFS server "smbserver", you would use the servicename //smbserver/printer
Note that the server name required is NOT necessarily the IP (DNS) host name of the server ! The name required is a NetBIOS server name, which may or may not be the same as the IP hostname of the machine running the server.
The server name is looked up according to either the -R|--name-resolve parameter to smbclient or using the name resolve order parameter in the smb.conf(5) file, allowing an administrator to change the order and methods by which server names are looked up.
password The password required to access the specified service on the specified server. If this parameter is supplied, the -N option (suppress password prompt) is assumed.
There is no default password. If no password is supplied on the command line (either by using this parameter or adding a password to the -U option (see below)) and the -N option is not specified, the client will prompt for a password, even if the desired service does not require one. (If no password is required, simply press ENTER to provide a null password.)
Note: Some servers (including OS/2 and Windows for Workgroups) insist on an uppercase password. Lowercase or mixed case passwords may be rejected by these servers.
Be cautious about including passwords in scripts.
-M|--message NetBIOS name This options allows you to send messages, using the "WinPopup" protocol, to another computer. Once a connection is established you then type your message, pressing ^D (control-D) to end.
If the receiving computer is running WinPopup the user will receive the message and probably a beep. If they are not running WinPopup the message will be lost, and no error message will occur.
The message is also automatically truncated if the message is over 1600 bytes, as this is the limit of the protocol.
One useful trick is to pipe the message through smbclient. For example: smbclient -M FRED < mymessage.txt will send the message in the file mymessage.txt to the machine FRED.
You may also find the -U and -I options useful, as they allow you to control the FROM and TO parts of the message.
See the message command parameter in the smb.conf(5) for a description of how to handle incoming WinPopup messages in Samba.
Note: Copy WinPopup into the startup group on your WfWg PCs if you want them to always be able to receive messages.
-g|--grepable This parameter provides combined with -L easy parseable output that allows processing with utilities such as grep and cut.
-m|--max-protocol protocol This allows the user to select the highest SMB protocol level that smbclient will use to connect to the server. By default this is set to highest available SMB3 protocol version. To connect using SMB2 or SMB1 protocol, use the strings SMB2 or NT1 respectively. Note that to connect to a Windows 2012 server with encrypted transport selecting a max-protocol of SMB3 is required.
-P|--machine-pass Make queries to the external server using the machine account of the local server.
-I|--ip-address IP-address IP address is the address of the server to connect to. It should be specified in standard "a.b.c.d" notation.
-E|--stderr This parameter causes the client to write messages to the standard error stream (stderr) rather than to the standard output stream.
By default, the client writes messages to standard output - typically the user's tty.
-L|--list This option allows you to look at what services are available on a server. You use it as smbclient -L host and a list should appear. The -I option may be useful if your NetBIOS names don't match your TCP/IP DNS host names or if you are trying to reach a host on another network.
-b|--send-buffer buffersize When sending or receiving files, smbclient uses an internal buffer sized by the maximum number of allowed requests to the connected server. This command allows this size to be set to any range between 0 (which means use the default server controlled size) bytes and 16776960 (0xFFFF00) bytes. Using the server controlled size is the most efficient as smbclient will pipeline as many simultaneous reads or writes needed to keep the server as busy as possible. Setting this to any other size will slow down the transfer. This can also be set using the iosize command inside smbclient.
-B|--browse Browse SMB servers using DNS.
-t|--timeout <timeout-seconds> This allows the user to tune the default timeout used for each SMB request. The default setting is 20 seconds. Increase it if requests to the server sometimes time out. This can happen when SMB3 encryption is selected and smbclient is overwhelming the server with requests. This can also be set using the timeout command inside smbclient.
-T|--tar tar options smbclient may be used to create tar(1) compatible backups of all the files on an SMB/CIFS share. The secondary tar flags that can be given to this option are:
•   c - Create a tar backup archive on the local system. Must be followed by the name of a tar file, tape device or "-" for standard output. If using standard output you must turn the log level to its lowest value -d0 to avoid corrupting your tar file. This flag is mutually exclusive with the x flag.
•   n - In combination with the c flag, do not actually create the archive, instead perform a dry run that attempts everything that involved in creation other than writing the file.
•   x - Extract (restore) a local tar file back to a share. Unless the -D option is given, the tar files will be restored from the top level of the share. Must be followed by the name of the tar file, device or "-" for standard input. Mutually exclusive with the c flag. Restored files have their creation times (mtime) set to the date saved in the tar file. Directories currently do not get their creation dates restored properly.
•   I - Include files and directories. Is the default behavior when filenames are specified above. Causes files to be included in an extract or create (and therefore everything else to be excluded). See example below. Filename globbing works in one of two ways. See r below.
•   X - Exclude files and directories. Causes files to be excluded from an extract or create. See example below. Filename globbing works in one of two ways. See r below.
•   F - File containing a list of files and directories. The F causes the name following the tarfile to create to be read as a filename that contains a list of files and directories to be included in an extract or create (and therefore everything else to be excluded). See example below. Filename globbing works in one of two ways. See r below.
•   b - Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in blocksize*TBLOCK (512 byte) blocks.
•   g - Incremental. Only back up files that have the archive bit set. Useful only with the c flag.
•   v - Verbose. Makes tar print out the files being processed. By default tar is not verbose. This is the same as tarmode verbose.
•   r - Use wildcard matching to include or exclude. Deprecated.
•   N - Newer than. Must be followed by the name of a file whose date is compared against files found on the share during a create. Only files newer than the file specified are backed up to the tar file. Useful only with the c flag.
•   a - Set archive bit. Causes the archive bit to be reset when a file is backed up. Useful with the g and c flags.
Tar Long File Names
smbclient's tar option now supports long file names both on backup and restore. However, the full path name of the file must be less than 1024 bytes. Also, when a tar archive is created, smbclient's tar option places all files in the archive with relative names, not absolute names.
Tar Filenames
All file names can be given as DOS path names (with '\\' as the component separator) or as UNIX path names (with '/' as the component separator).
Restore from tar file backup.tar into myshare on mypc (no password on share).
smbclient //mypc/myshare "" -N -Tx backup.tar
Restore everything except users/docs
smbclient //mypc/myshare "" -N -TXx backup.tar users/docs
Create a tar file of the files beneath users/docs.
smbclient //mypc/myshare "" -N -Tc backup.tar users/docs
Create the same tar file as above, but now use a DOS path name.
smbclient //mypc/myshare "" -N -Tc backup.tar users\edocs
Create a tar file of the files listed in the file tarlist.
smbclient //mypc/myshare "" -N -TcF backup.tar tarlist
Create a tar file of all the files and directories in the share.
smbclient //mypc/myshare "" -N -Tc backup.tar *
-D|--directory initial directory Change to initial directory before starting. Probably only of any use with the tar -T option.
-c|--command command string command string is a semicolon-separated list of commands to be executed instead of prompting from stdin. -N is implied by -c.
This is particularly useful in scripts and for printing stdin to the server, e.g.  -c 'print -'.
Once the client is running, the user is presented with a prompt :
smb:\>
The backslash ("\\") indicates the current working directory on the server, and will change if the current working directory is changed.
The prompt indicates that the client is ready and waiting to carry out a user command. Each command is a single word, optionally followed by parameters specific to that command. Command and parameters are space-delimited unless these notes specifically state otherwise. All commands are case-insensitive. Parameters to commands may or may not be case sensitive, depending on the command.
You can specify file names which have spaces in them by quoting the name with double quotes, for example "a long file name".
Parameters shown in square brackets (e.g., "[parameter]") are optional. If not given, the command will use suitable defaults. Parameters shown in angle brackets (e.g., "<parameter>") are required.
Note that all commands operating on the server are actually performed by issuing a request to the server. Thus the behavior may vary from server to server, depending on how the server was implemented.
The commands available are given here in alphabetical order.
? [command] If command is specified, the ? command will display a brief informative message about the specified command. If no command is specified, a list of available commands will be displayed.
! [shell command] If shell command is specified, the ! command will execute a shell locally and run the specified shell command. If no command is specified, a local shell will be run.
allinfo file The client will request that the server return all known information about a file or directory (including streams).
altname file The client will request that the server return the "alternate" name (the 8.3 name) for a file or directory.
archive <number> Sets the archive level when operating on files. 0 means ignore the archive bit, 1 means only operate on files with this bit set, 2 means only operate on files with this bit set and reset it after operation, 3 means operate on all files and reset it after operation. The default is 0.
backup Toggle the state of the "backup intent" flag sent to the server on directory listings and file opens. If the "backup intent" flag is true, the server will try and bypass some file system checks if the user has been granted SE_BACKUP or SE_RESTORE privileges. This state is useful when performing a backup or restore operation.
blocksize <number> Sets the blocksize parameter for a tar operation. The default is 20. Causes tar file to be written out in blocksize*TBLOCK (normally 512 byte) units.
cancel jobid0 [jobid1] ... [jobidN] The client will request that the server cancel the printjobs identified by the given numeric print job ids.
case_sensitive Toggles the setting of the flag in SMB packets that tells the server to treat filenames as case sensitive. Set to OFF by default (tells file server to treat filenames as case insensitive). Only currently affects Samba 3.0.5 and above file servers with the case sensitive parameter set to auto in the smb.conf.
cd <directory name> If "directory name" is specified, the current working directory on the server will be changed to the directory specified. This operation will fail if for any reason the specified directory is inaccessible.
If no directory name is specified, the current working directory on the server will be reported.
chmod file mode in octal This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server change the UNIX permissions to the given octal mode, in standard UNIX format.
chown file uid gid This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server change the UNIX user and group ownership to the given decimal values. Note there is currently no way to remotely look up the UNIX uid and gid values for a given name. This may be addressed in future versions of the CIFS UNIX extensions.
close <fileid> Closes a file explicitly opened by the open command. Used for internal Samba testing purposes.
del <mask> The client will request that the server attempt to delete all files matching mask from the current working directory on the server.
deltree <mask> The client will request that the server attempt to delete all files and directories matching mask from the current working directory on the server. Note this will recursively delete files and directories within the directories selected even without the recurse command being set. If any of the delete requests fail the command will stop processing at that point, leaving files and directories not yet processed untouched. This is by design.
dir <mask> A list of the files matching mask in the current working directory on the server will be retrieved from the server and displayed.
du <filename> Does a directory listing and then prints out the current disk usage and free space on a share.
echo <number> <data> Does an SMBecho request to ping the server. Used for internal Samba testing purposes.
exit Terminate the connection with the server and exit from the program.
get <remote file name> [local file name] Copy the file called remote file name from the server to the machine running the client. If specified, name the local copy local file name. Note that all transfers in smbclient are binary. See also the lowercase command.
getfacl <filename> Requires the server support the UNIX extensions. Requests and prints the POSIX ACL on a file.
hardlink <src> <dest> Creates a hardlink on the server using Windows CIFS semantics.
help [command] See the ? command above.
history Displays the command history.
iosize <bytes> When sending or receiving files, smbclient uses an internal buffer sized by the maximum number of allowed requests to the connected server. This command allows this size to be set to any range between 0 (which means use the default server controlled size) bytes and 16776960 (0xFFFF00) bytes. Using the server controlled size is the most efficient as smbclient will pipeline as many simultaneous reads or writes needed to keep the server as busy as possible. Setting this to any other size will slow down the transfer.
lcd [directory name] If directory name is specified, the current working directory on the local machine will be changed to the directory specified. This operation will fail if for any reason the specified directory is inaccessible.
If no directory name is specified, the name of the current working directory on the local machine will be reported.
link target linkname This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server create a hard link between the linkname and target files. The linkname file must not exist.
listconnect Show the current connections held for DFS purposes.
lock <filenum> <r|w> <hex-start> <hex-len> This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Tries to set a POSIX fcntl lock of the given type on the given range. Used for internal Samba testing purposes.
logon <username> <password> Establishes a new vuid for this session by logging on again. Replaces the current vuid. Prints out the new vuid. Used for internal Samba testing purposes.
logoff Logs the user off the server, closing the session. Used for internal Samba testing purposes.
lowercase Toggle lowercasing of filenames for the get and mget commands.
When lowercasing is toggled ON, local filenames are converted to lowercase when using the get and mget commands. This is often useful when copying (say) MSDOS files from a server, because lowercase filenames are the norm on UNIX systems.
ls <mask> See the dir command above.
mask <mask> This command allows the user to set up a mask which will be used during recursive operation of the mget and mput commands.
The masks specified to the mget and mput commands act as filters for directories rather than files when recursion is toggled ON.
The mask specified with the mask command is necessary to filter files within those directories. For example, if the mask specified in an mget command is "source*" and the mask specified with the mask command is "*.c" and recursion is toggled ON, the mget command will retrieve all files matching "*.c" in all directories below and including all directories matching "source*" in the current working directory.
Note that the value for mask defaults to blank (equivalent to "*") and remains so until the mask command is used to change it. It retains the most recently specified value indefinitely. To avoid unexpected results it would be wise to change the value of mask back to "*" after using the mget or mput commands.
md <directory name> See the mkdir command.
mget <mask> Copy all files matching mask from the server to the machine running the client.
Note that mask is interpreted differently during recursive operation and non-recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in smbclient are binary. See also the lowercase command.
mkdir <directory name> Create a new directory on the server (user access privileges permitting) with the specified name.
more <file name> Fetch a remote file and view it with the contents of your PAGER environment variable.
mput <mask> Copy all files matching mask in the current working directory on the local machine to the current working directory on the server.
Note that mask is interpreted differently during recursive operation and non-recursive operation - refer to the recurse and mask commands for more information. Note that all transfers in smbclient are binary.
notify <dir name> Query a directory for change notifications. This command issues a recursive filechangenotify call for all possible changes. As changes come in will print one line per change. See https://msdn.microsoft.com/en-us/library/dn392331.aspx for a description of the action numbers that this command prints.
This command never ends, it waits for event indefinitely.
posix Query the remote server to see if it supports the CIFS UNIX extensions and prints out the list of capabilities supported. If so, turn on POSIX pathname processing and large file read/writes (if available),.
posix_encrypt <domain> <username> <password> This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Attempt to negotiate SMB encryption on this connection. If smbclient connected with kerberos credentials (-k) the arguments to this command are ignored and the kerberos credentials are used to negotiate GSSAPI signing and sealing instead. See also the -e option to smbclient to force encryption on initial connection. This command is new with Samba 3.2.
posix_open <filename> <octal mode> This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Opens a remote file using the CIFS UNIX extensions and prints a fileid. Used for internal Samba testing purposes.
posix_mkdir <directoryname> <octal mode> This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Creates a remote directory using the CIFS UNIX extensions with the given mode.
posix_rmdir <directoryname> This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Deletes a remote directory using the CIFS UNIX extensions.
posix_unlink <filename> This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Deletes a remote file using the CIFS UNIX extensions.
posix_whoami Query the remote server for the user token using the CIFS UNIX extensions WHOAMI call. Prints out the guest status, user, group, group list and sid list that the remote server is using on behalf of the logged on user.
print <file name> Print the specified file from the local machine through a printable service on the server.
prompt Toggle prompting for filenames during operation of the mget and mput commands.
When toggled ON, the user will be prompted to confirm the transfer of each file during these commands. When toggled OFF, all specified files will be transferred without prompting.
put <local file name> [remote file name] Copy the file called local file name from the machine running the client to the server. If specified, name the remote copy remote file name. Note that all transfers in smbclient are binary. See also the lowercase command.
queue Displays the print queue, showing the job id, name, size and current status.
quit See the exit command.
readlink symlinkname This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Print the value of the symlink "symlinkname".
rd <directory name> See the rmdir command.
recurse Toggle directory recursion for the commands mget and mput.
When toggled ON, these commands will process all directories in the source directory (i.e., the directory they are copying from ) and will recurse into any that match the mask specified to the command. Only files that match the mask specified using the mask command will be retrieved. See also the mask command.
When recursion is toggled OFF, only files from the current working directory on the source machine that match the mask specified to the mget or mput commands will be copied, and any mask specified using the mask command will be ignored.
rename <old filename> <new filename> [-f] Rename files in the current working directory on the server from old filename to new filename. The optional -f switch allows for superseding the destination file, if it exists. This is supported by NT1 protocol dialect and SMB2 protocol family.
rm <mask> Remove all files matching mask from the current working directory on the server.
rmdir <directory name> Remove the specified directory (user access privileges permitting) from the server.
scopy <source filename> <destination filename> Attempt to copy a file on the server using the most efficient server-side copy calls. Falls back to using read then write if server doesn't support server-side copy.
setmode <filename> <perm=[+|\-]rsha> A version of the DOS attrib command to set file permissions. For example:
setmode myfile +r
would make myfile read only.
showconnect Show the currently active connection held for DFS purposes.
stat file This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests the UNIX basic info level and prints out the same info that the Linux stat command would about the file. This includes the size, blocks used on disk, file type, permissions, inode number, number of links and finally the three timestamps (access, modify and change). If the file is a special file (symlink, character or block device, fifo or socket) then extra information may also be printed.
symlink target linkname This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. The client requests that the server create a symbolic hard link between the target and linkname files. The linkname file must not exist. Note that the server will not create a link to any path that lies outside the currently connected share. This is enforced by the Samba server.
tar <c|x>[IXbgNa] Performs a tar operation - see the -T command line option above. Behavior may be affected by the tarmode command (see below). Using g (incremental) and N (newer) will affect tarmode settings. Note that using the "-" option with tar x may not work - use the command line option instead.
blocksize <blocksize> Blocksize. Must be followed by a valid (greater than zero) blocksize. Causes tar file to be written out in blocksize*TBLOCK (512 byte) blocks.
tarmode <full|inc|reset|noreset|system|nosystem|hidden|nohidden|verbose|noverbose> Changes tar's behavior with regard to DOS attributes. There are 4 modes which can be turned on or off.
Incremental mode (default off). When off (using full) tar will back up everything regardless of the archive bit setting. When on (using inc), tar will only back up files with the archive bit set.
Reset mode (default off). When on (using reset), tar will remove the archive bit on all files it backs up (implies read/write share). Use noreset to turn off.
System mode (default on). When off, tar will not backup system files. Use nosystem to turn off.
Hidden mode (default on). When off, tar will not backup hidden files. Use nohidden to turn off.
timeout <per-operation timeout in seconds> This allows the user to tune the default timeout used for each SMB request. The default setting is 20 seconds. Increase it if requests to the server sometimes time out. This can happen when SMB3 encryption is selected and smbclient is overwhelming the server with requests.
unlock <filenum> <hex-start> <hex-len> This command depends on the server supporting the CIFS UNIX extensions and will fail if the server does not. Tries to unlock a POSIX fcntl lock on the given range. Used for internal Samba testing purposes.
volume Prints the current volume name of the share.
vuid <number> Changes the currently used vuid in the protocol to the given arbitrary number. Without an argument prints out the current vuid being used. Used for internal Samba testing purposes.
tcon <sharename> Establishes a new tree connect (connection to a share). Replaces the current tree connect. Prints the new tid (tree id). Used for internal Samba testing purposes.
tdis Close the current share connection (tree disconnect). Used for internal Samba testing purposes.
tid <number> Changes the current tree id (tid) in the protocol to a new arbitrary number. Without an argument, it prints out the tid currently used. Used for internal Samba testing purposes.
utimes <filename> <create time> <access time> <write time> < change time> Changes the timestamps on a file by name. Times should be specified in the format [YY]YY:MM:DD-HH:MM:SS or -1 for no change.
Some servers are fussy about the case of supplied usernames, passwords, share names (AKA service names) and machine names. If you fail to connect try giving all parameters in uppercase.
It is often necessary to use the -n option when connecting to some types of servers. For example OS/2 LanManager insists on a valid NetBIOS name being used, so you need to supply a valid name that would be known to the server.
smbclient supports long file names where the server supports the LANMAN2 protocol or above.
See the --user and --password options for details on ways to specify a username and password via an environment variable.
The location of the client program is a matter for individual system administrators. The following are thus suggestions only.
It is recommended that the smbclient software be installed in the /usr/local/samba/bin/ or /usr/samba/bin/ directory, this directory readable by all, writeable only by root. The client program itself should be executable by all. The client should NOT be setuid or setgid!
The client log files should be put in a directory readable and writeable only by the user.
To test the client, you will need to know the name of a running SMB/CIFS server. It is possible to run smbd(8) as an ordinary user - running that server as a daemon on a user-accessible port (typically any port number over 1024) would provide a suitable test server.
Most diagnostics issued by the client are logged in a specified log file. The log file name is specified at compile time, but may be overridden on the command line.
The number and nature of diagnostics available depends on the debug level used by the client. If you have problems, set the debug level to 3 and peruse the log files.
docker-cp - Copy files/folders between a container and the local filesystem
docker cp [OPTIONS] CONTAINER:SRC_PATH DEST_PATH|-      docker cp [OPTIONS] SRC_PATH|- CONTAINER:DEST_PATH
Alias for docker container cp.
-a, --archive[=false]      Archive mode (copy all uid/gid information)
-L, --follow-link[=false]      Always follow symbol link in SRC_PATH
-h, --help[=false]      help for cp
ETCKEEPER(8)                                                        ETCKEEPER(8)
etckeeper - store /etc in git, mercurial, bazaar, or darcs
etckeeper command [-d directory]
etckeeper manages /etc be stored in a git, mercurial, bazaar, or darcs repository. By default each of the commands operates on /etc, but a different directory can be specified to operate on a clone of the /etc repository located elsewhere.
init   This initialises and sets up a git, mercurial, bazaar, or darcs repository (depending on the VCS setting in /etc/etckeeper/etckeeper.conf). Typically this is run in /etc once when starting to use etckeeper on a machine. It can also be used to initialise a clone of the /etc repository located elsewhere.
commit [message] Commits all changes in /etc to the repository. A commit message can be specified. You may also use the underlying VCS to commit manually.  (Note that etckeeper commit will notice if a user has used sudo or su to become root, and record the original username in the commit.)
pre-commit This is called as a pre-commit hook. It stores metadata and does sanity checks.
pre-install This is called by apt's DPkg::Pre-Install-Pkgs hook, or by equivalent hooks of other package managers. It allows committing any uncommitted changes before packages are installed, upgraded, etc.
post-install This is called by apt's DPkg::Post-Invoke hook, or by equivalent hooks of other package managers. It commits changes made by packages into the repository. (You can also call this by hand after running dpkg by hand.)
unclean This returns true if the directory contains uncommitted changes.
update-ignore [-a] This updates the VCS ignore file. Content outside a "managed by etckeeper" block is not touched. This is generally run when upgrading to a new version of etckeeper. (The -a switch will add a "managed by etckeeper" block if one is not present.)
vcs subcommand [options ...] You can use this to run any subcommand of the VCS that etckeeper is configured to run. It will be run in /etc. For example, "etckeeper vcs diff" will run "git diff", etc.
uninit [-f] This command DESTROYS DATA! It is the inverse of the init command, removing VCS information and etckeeper's own bookkeeping information from the directory. Use with caution. A typical use case would be to run etckeeper uninit, then modify etckeeper.conf to use a different VCS, and then run etckeeper init. (The -f switch can be used to force uninit without prompting.)
/etc/etckeeper/etckeeper.conf is the configuration file.
/etc/etckeeper also contains directories containing the programs that are run for each of the above commands.
ETCKEEPER_CONF_DIR path to configuration directory instead of default /etc/etckeeper.
/usr/share/doc/etckeeper/README.md.gz
RUNUSER(1)                        User Commands                       RUNUSER(1)
runuser - run a command with substitute user and group ID
runuser [options] -u user [[--] command [argument...]]
runuser [options] [-] [user [argument...]]
runuser can be used to run commands with a substitute user and group ID. If the option -u is not given, runuser falls back to su-compatible semantics and a shell is executed. The difference between the commands runuser and su is that runuser does not ask for a password (because it may be executed by the root user only) and it uses a different PAM configuration. The command runuser does not have to be installed with set-user-ID permissions.
If the PAM session is not required, then the recommended solution is to use the setpriv(1) command.
When called without arguments, runuser defaults to running an interactive shell as root.
For backward compatibility, runuser defaults to not changing the current directory and to setting only the environment variables HOME and SHELL (plus USER and LOGNAME if the target user is not root). This version of runuser uses PAM for session management.
Note that runuser in all cases use PAM (pam_getenvlist()) to do the final environment modification. Command-line options such as --login and --preserve-environment affect the environment before it is modified by PAM.
-c, --command=command Pass command to the shell with the -c option.
-f, --fast Pass -f to the shell, which may or may not be useful, depending on the shell.
-g, --group=group The primary group to be used. This option is allowed for the root user only.