id stringlengths 4 63 | text stringlengths 153 8.81M |
|---|---|
zl3073x_write_hwreg(9) | NAME zl3073x_write_hwreg - Write value to HW register
SYNOPSIS int zl3073x_write_hwreg (struct zl3073x_dev *zldev , u32 addr , u32 value );
ARGUMENTS zldev zl3073x device pointer
addr HW registers address
value Value to be written to HW register
DESCRIPTION Stores the requested val... |
zl3073x_write_hwreg_seq(9) | NAME zl3073x_write_hwreg_seq - Write HW registers sequence
SYNOPSIS int zl3073x_write_hwreg_seq (struct zl3073x_dev *zldev , const struct zl3073x_hwreg_seq_item *seq , size_t num_items );
ARGUMENTS zldev pointer to device structure
seq pointer to first sequence item
num_items number of... |
zl3073x_write_u16(9) | NAME zl3073x_write_u16 - write value to 16bit register
SYNOPSIS int zl3073x_write_u16 (struct zl3073x_dev *zldev , unsigned int reg , u16 val );
ARGUMENTS zldev zl3073x device pointer
reg register to write to
val value to write
DESCRIPTION Writes value into given 16bit register.... |
zl3073x_write_u32(9) | NAME zl3073x_write_u32 - write value to 32bit register
SYNOPSIS int zl3073x_write_u32 (struct zl3073x_dev *zldev , unsigned int reg , u32 val );
ARGUMENTS zldev zl3073x device pointer
reg register to write to
val value to write
DESCRIPTION Writes value into given 32bit register.... |
zl3073x_write_u48(9) | NAME zl3073x_write_u48 - write value to 48bit register
SYNOPSIS int zl3073x_write_u48 (struct zl3073x_dev *zldev , unsigned int reg , u64 val );
ARGUMENTS zldev zl3073x device pointer
reg register to write to
val value to write
DESCRIPTION Writes value into given 48bit register.... |
zl3073x_write_u8(9) | NAME zl3073x_write_u8 - write value to 16bit register
SYNOPSIS int zl3073x_write_u8 (struct zl3073x_dev *zldev , unsigned int reg , u8 val );
ARGUMENTS zldev zl3073x device pointer
reg register to write to
val value to write
DESCRIPTION Writes value into given 8bit register.
RE... |
zless(1) | NAME zless - file perusal filter for crt viewing of compressed text
SYNOPSIS zless [ name ... ]
DESCRIPTION The zless command is a filter which allows examination of compressed or plain text files one screenful at a time on a soft-copy terminal. It is the equivalent of setting the environment variable LESSOPEN to ... |
zmore(1) | NAME zmore - file perusal filter for crt viewing of compressed text
SYNOPSIS zmore [ name ... ]
DESCRIPTION The zmore command is a filter which allows examination of compressed or plain text files one screenful at a time on a soft-copy terminal. The zmore command works on files compressed with compress, pack or gz... |
znew(1) | NAME znew - recompress .Z files to .gz files
SYNOPSIS znew [ -ftv9PK] [ name.Z ... ]
DESCRIPTION The Znew command recompresses files from .Z (compress) format to .gz (gzip) format. If you want to recompress a file already in gzip format, rename the file to force a .Z extension then apply znew.
OPTIONS -f For... |
zpa2326_clear_fifo(9) | NAME zpa2326_clear_fifo - Clear remaining entries in hardware FIFO.
SYNOPSIS int zpa2326_clear_fifo (const struct iio_dev *indio_dev , unsigned int min_count );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
min_count Number of samples present within hardware FIFO.
DESCRIPTION ... |
zpa2326_config_oneshot(9) | NAME zpa2326_config_oneshot - Setup device for one shot / on demand mode.
SYNOPSIS int zpa2326_config_oneshot (const struct iio_dev *indio_dev , int irq );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
irq Optional interrupt line the hardware uses to notify new data sampl... |
zpa2326_dequeue_pressure(9) | NAME zpa2326_dequeue_pressure - Retrieve the most recent pressure sample from hardware FIFO.
SYNOPSIS int zpa2326_dequeue_pressure (const struct iio_dev *indio_dev , u32 *pressure );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
pressure Sampled pressure output.
DESCRIPTION N... |
zpa2326_enable_device(9) | NAME zpa2326_enable_device - Enable device, i.e. get out of low power mode.
SYNOPSIS int zpa2326_enable_device (const struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the hardware to enable.
DESCRIPTION Required to access complete register space and to perform any sampling or control... |
zpa2326_fetch_raw_sample(9) | NAME zpa2326_fetch_raw_sample - Retrieve a raw sample and convert it to CPU endianness.
SYNOPSIS int zpa2326_fetch_raw_sample (const struct iio_dev *indio_dev , enum iio_chan_type type , int *value );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
type Type of measurement /... |
zpa2326_fill_sample_buffer(9) | NAME zpa2326_fill_sample_buffer - Enqueue new channel samples to IIO buffer.
SYNOPSIS int zpa2326_fill_sample_buffer (struct iio_dev *indio_dev , const struct zpa2326_private *private );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
private Internal private state related to i... |
zpa2326_handle_irq(9) | NAME zpa2326_handle_irq - Process hardware interrupts.
SYNOPSIS irqreturn_t zpa2326_handle_irq (int irq , void *data );
ARGUMENTS irq Interrupt line the hardware uses to notify new data has arrived.
data The IIO device associated with the sampling hardware.
DESCRIPTION Timestamp buffered sampl... |
zpa2326_handle_threaded_irq(9) | NAME zpa2326_handle_threaded_irq - Interrupt bottom-half handler.
SYNOPSIS irqreturn_t zpa2326_handle_threaded_irq (int irq , void *data );
ARGUMENTS irq Interrupt line the hardware uses to notify new data has arrived.
data The IIO device associated with the sampling hardware.
DESCRIPTION Main... |
zpa2326_init_managed_trigger(9) | NAME zpa2326_init_managed_trigger - Create interrupt driven / hardware trigger allowing to notify external devices a new sample is ready.
SYNOPSIS int zpa2326_init_managed_trigger (struct device *parent , struct iio_dev *indio_dev , struct zpa2326_private *private , int irq );
ARGUMENTS parent Hardware sampling ... |
zpa2326_poll_oneshot_completion(9) | NAME zpa2326_poll_oneshot_completion - Actively poll for one shot data ready.
SYNOPSIS int zpa2326_poll_oneshot_completion (const struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
DESCRIPTION Loop over registers content to detect end of sampling cycle. Used when... |
zpa2326_postenable_buffer(9) | NAME zpa2326_postenable_buffer - Configure device for triggered sampling.
SYNOPSIS int zpa2326_postenable_buffer (struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
DESCRIPTION Basically setup one-shot mode if plugging external trigger. Otherwise, let intern... |
zpa2326_power_off(9) | NAME zpa2326_power_off - Power off device, i.e. disable attached power regulators.
SYNOPSIS void zpa2326_power_off (const struct iio_dev *indio_dev , const struct zpa2326_private *private );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
private Internal private state related ... |
zpa2326_power_on(9) | NAME zpa2326_power_on - Power on device to allow subsequent configuration.
SYNOPSIS int zpa2326_power_on (const struct iio_dev *indio_dev , const struct zpa2326_private *private );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
private Internal private state related to indio_d... |
zpa2326_preenable_buffer(9) | NAME zpa2326_preenable_buffer - Prepare device for configuring triggered sampling modes.
SYNOPSIS int zpa2326_preenable_buffer (struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
DESCRIPTION Basically power up device. Called with IIO device's lock held.
RETURN ... |
zpa2326_probe(9) | NAME zpa2326_probe - Instantiate and register core ZPA2326 IIO device
SYNOPSIS int zpa2326_probe (struct device *parent , const char *name , int irq , unsigned int hwid , struct regmap *regmap );
ARGUMENTS parent Hardware sampling device the created IIO device will be a child of.
name Arbitrary na... |
zpa2326_remove(9) | NAME zpa2326_remove - Unregister and destroy core ZPA2326 IIO device.
SYNOPSIS void zpa2326_remove (const struct device *parent );
ARGUMENTS parent Hardware sampling device the IIO device to remove is a child of.
SEE ALSO Kernel file ./drivers/iio/pressure/zpa2326.h zpa2326_probe(9)
April 2026 ... |
zpa2326_reset_device(9) | NAME zpa2326_reset_device - Reset device to default hardware state.
SYNOPSIS int zpa2326_reset_device (const struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the hardware to reset.
DESCRIPTION Disable sampling and empty hardware FIFO. Device must be enabled before reset, i.e. not in... |
zpa2326_resume(9) | NAME zpa2326_resume - Request the PM layer to power supply the device.
SYNOPSIS int zpa2326_resume (const struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
RETURN < 0 - a negative error code meaning failure ; 0 - success, device has just been powered up ; 1 - su... |
zpa2326_sample_oneshot(9) | NAME zpa2326_sample_oneshot - Perform a complete one shot sampling cycle.
SYNOPSIS int zpa2326_sample_oneshot (struct iio_dev *indio_dev , enum iio_chan_type type , int *value );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
type Type of measurement / channel to fetch from... |
zpa2326_set_trigger_state(9) | NAME zpa2326_set_trigger_state - Start / stop continuous sampling.
SYNOPSIS int zpa2326_set_trigger_state (struct iio_trigger *trig , bool state );
ARGUMENTS trig The trigger being attached to IIO device associated with the sampling hardware.
state Tell whether to start (true) or stop (false)
DE... |
zpa2326_sleep(9) | NAME zpa2326_sleep - Disable device, i.e. switch to low power mode.
SYNOPSIS int zpa2326_sleep (const struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the hardware to disable.
DESCRIPTION Only ZPA2326_DEVICE_ID_REG and ZPA2326_CTRL_REG0_REG registers may be accessed once device is in... |
zpa2326_start_oneshot(9) | NAME zpa2326_start_oneshot - Start a single sampling cycle, i.e. in one shot mode.
SYNOPSIS int zpa2326_start_oneshot (const struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
DESCRIPTION Device must have been previously enabled and configured for one shot mode. ... |
zpa2326_suspend(9) | NAME zpa2326_suspend - Schedule a power down using autosuspend feature of PM layer.
SYNOPSIS void zpa2326_suspend (struct iio_dev *indio_dev );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
DESCRIPTION Device is switched to low power mode at first to save power even when attached regula... |
zpa2326_trigger_handler(9) | NAME zpa2326_trigger_handler - Perform an IIO buffered sampling round in one shot mode.
SYNOPSIS irqreturn_t zpa2326_trigger_handler (int irq , void *data );
ARGUMENTS irq The software interrupt assigned to data
data The IIO poll function dispatched by external trigger our device is attached to... |
zpa2326_wait_oneshot_completion(9) | NAME zpa2326_wait_oneshot_completion - Wait for oneshot data ready interrupt.
SYNOPSIS int zpa2326_wait_oneshot_completion (const struct iio_dev *indio_dev , struct zpa2326_private *private );
ARGUMENTS indio_dev The IIO device associated with the sampling hardware.
private Internal private state relate... |
zpci_add_device(9) | NAME zpci_add_device - Add a previously created zPCI device to the zPCI subsystem
SYNOPSIS int zpci_add_device (struct zpci_dev *zdev );
ARGUMENTS zdev The zPCI device to be added
DESCRIPTION A struct zpci_dev is added to the zPCI subsystem and to a virtual PCI bus creating a new one as necessary. A hotp... |
zpci_bus_for_each(9) | NAME zpci_bus_for_each - iterate over all the registered zbus objects
SYNOPSIS zpci_bus_for_each (pos );
ARGUMENTS pos a struct zpci_bus * as cursor
DESCRIPTION Acquires and releases references as the cursor iterates over the registered objects. Is tolerant against concurrent removals of objects.
CONTEXT Pr... |
zpci_bus_get_next(9) | NAME zpci_bus_get_next - get the next zbus object from given position in the list
SYNOPSIS void zpci_bus_get_next (struct zpci_bus **pos );
ARGUMENTS pos current position/cursor in the global zbus list
DESCRIPTION Acquires and releases references as the cursor iterates (might also free/ release the cursor). ... |
zpci_bus_release(9) | NAME zpci_bus_release - Un-initialize resources associated with the zbus and free memory
SYNOPSIS void zpci_bus_release (struct kref *kref );
ARGUMENTS kref refcount * that is part of struct zpci_bus
DESCRIPTION MUST be called with `zbus_list_lock` held, but the lock is released during run of the function.
S... |
zpci_clear_error_state(9) | NAME zpci_clear_error_state - Clears the zPCI error state of the device
SYNOPSIS int zpci_clear_error_state (struct zpci_dev *zdev );
ARGUMENTS zdev The zdev for which the zPCI error state should be reset
DESCRIPTION Clear the zPCI error state of the device. If clearing the zPCI error state fails the device i... |
zpci_create_device(9) | NAME zpci_create_device - Create a new zpci_dev and add it to the zbus
SYNOPSIS struct zpci_dev * zpci_create_device (u32 fid , u32 fh , enum zpci_state state );
ARGUMENTS fid Function ID of the device to be created
fh Current Function Handle of the device to be created
state In... |
zpci_deconfigure_device(9) | NAME zpci_deconfigure_device - Deconfigure a zpci_dev
SYNOPSIS int zpci_deconfigure_device (struct zpci_dev *zdev );
ARGUMENTS zdev The zpci_dev to configure
DESCRIPTION Deconfigure a zPCI function that is currently configured and possibly known to the common code PCI subsystem. If any failure occurs the dev... |
zpci_device_reserved(9) | NAME zpci_device_reserved - Mark device as reserved
SYNOPSIS void zpci_device_reserved (struct zpci_dev *zdev );
ARGUMENTS zdev the zpci_dev that was reserved
DESCRIPTION Handle the case that a given zPCI function was reserved by another system.
SEE ALSO Kernel file ./arch/s390/pci/pci.c zpci_hot_re... |
zpci_hot_reset_device(9) | NAME zpci_hot_reset_device - perform a reset of the given zPCI function
SYNOPSIS int zpci_hot_reset_device (struct zpci_dev *zdev );
ARGUMENTS zdev the slot which should be reset
DESCRIPTION Performs a low level reset of the zPCI function. The reset is low level in the sense that the zPCI function can be re... |
zpci_iov_find_parent_pf(9) | NAME zpci_iov_find_parent_pf - Find the parent PF, if any, of the given function
SYNOPSIS struct pci_dev * zpci_iov_find_parent_pf (struct zpci_bus *zbus , struct zpci_dev *zdev );
ARGUMENTS zbus The bus that the PCI function is on, or would be added on
zdev The PCI function
DESCRIPTION Finds ... |
zpci_report_status(9) | NAME zpci_report_status - Report the status of operations on a PCI device
SYNOPSIS int zpci_report_status (struct zpci_dev *zdev , const char *operation , const char *status );
ARGUMENTS zdev The PCI device for which to report status
operation A string representing the operation reported
stat... |
zpci_reset_load_store_blocked(9) | NAME zpci_reset_load_store_blocked - Re-enables L/S from error state
SYNOPSIS int zpci_reset_load_store_blocked (struct zpci_dev *zdev );
ARGUMENTS zdev The zdev for which to unblock load/store access
DESCRIPTION Re-enables load/store access for a PCI function in the error state while keeping DMA blocked. I... |
zpci_scan_configured_device(9) | NAME zpci_scan_configured_device - Scan a freshly configured zpci_dev
SYNOPSIS int zpci_scan_configured_device (struct zpci_dev *zdev , u32 fh );
ARGUMENTS zdev The zpci_dev to be configured
fh The general function handle supplied by the platform
DESCRIPTION Given a device in the configuratio... |
zpdesc_folio(9) | NAME zpdesc_folio - The folio allocated for a zpdesc
SYNOPSIS zpdesc_folio (zp );
ARGUMENTS zp The zpdesc.
DESCRIPTION Zpdescs are descriptors for zsmalloc memory. The memory itself is allocated as folios that contain the zsmalloc objects, and zpdesc uses specific fields in the first struct page of the ... |
zramctl(8) | NAME zramctl - set up and control zram devices
SYNOPSIS Get info: zramctl [options]
Reset zram:
zramctl -r zramdev...
Print name of first unused zram device:
zramctl -f
Set up a zram device:
zramctl [-f | zramdev] [-s size] [-t number] [-a algorithm]
DESCRIPTIO... |
zrun(1) | NAME zrun - automatically uncompress arguments to command
SYNOPSIS zrun command file.gz [...]
DESCRIPTION Prefixing a shell command with "zrun" causes any compressed files that are arguments of the command to be transparently uncompressed to temp files (not pipes) and the uncompressed files fed to the command.
... |
zs_create_pool(9) | NAME zs_create_pool - Creates an allocation pool to work from.
SYNOPSIS struct zs_pool * zs_create_pool (const char *name );
ARGUMENTS name pool name to be created
DESCRIPTION This function must be called before anything when using the zsmalloc allocator. On success, a pointer to the newly created pool is re... |
zs_huge_class_size(9) | NAME zs_huge_class_size - Returns the size (in bytes) of the first huge zsmalloc &size_class.
SYNOPSIS size_t zs_huge_class_size (struct zs_pool *pool );
ARGUMENTS pool zsmalloc pool to use
DESCRIPTION The function returns the size of the first huge class - any object of equal or bigger size will be stored in... |
zs_lookup_class_index(9) | NAME zs_lookup_class_index - Returns index of the zsmalloc &size_class that hold objects of the provided size.
SYNOPSIS unsigned int zs_lookup_class_index (struct zs_pool *pool , unsigned int size );
ARGUMENTS pool zsmalloc pool to use
size object size
CONTEXT Any context.
RETURN the index of ... |
zs_malloc(9) | NAME zs_malloc - Allocate block of given size from pool.
SYNOPSIS unsigned long zs_malloc (struct zs_pool *pool , size_t size , gfp_t gfp , const int nid );
ARGUMENTS pool pool to allocate from
size size of block to allocate
gfp gfp flags when allocating object
nid ... |
zsoelim(1) | NAME zsoelim - satisfy .so requests in roff input
SYNOPSIS zsoelim [-CVh] [file ...]
DESCRIPTION zsoelim parses file arguments, or if none are specified, its standard input for lines of the form:
.so <filename>
These requests are replaced by the contents of the filename specified. If the request can... |
zstd(1) | NAME zstd - zstd, zstdmt, unzstd, zstdcat - Compress or decompress .zst files
SYNOPSIS zstd [OPTIONS] [-|INPUT-FILE] [-o OUTPUT-FILE]
zstdmt is equivalent to zstd -T0
unzstd is equivalent to zstd -d
zstdcat is equivalent to zstd -dcf
DESCRIPTION zstd is a fast lossless compression algorithm ... |
zstd_cctx_set_param(9) | NAME zstd_cctx_set_param - sets a compression parameter
SYNOPSIS size_t zstd_cctx_set_param (zstd_cctx *cctx , zstd_cparameter param , int value );
ARGUMENTS cctx The context. Must have been initialized with zstd_init_cctx.
param The parameter to set.
value The value to set the para... |
zstd_cctx_workspace_bound(9) | NAME zstd_cctx_workspace_bound - max memory needed to initialize a zstd_cctx
SYNOPSIS size_t zstd_cctx_workspace_bound (const zstd_compression_parameters *parameters );
ARGUMENTS parameters The compression parameters to be used.
DESCRIPTION If multiple compression parameters might be used, the caller must call zstd... |
zstd_cctx_workspace_bound_with_ext_seq_prod(9) | NAME zstd_cctx_workspace_bound_with_ext_seq_prod - max memory needed to initialize a zstd_cctx when using the block-level external sequence producer API.
SYNOPSIS size_t zstd_cctx_workspace_bound_with_ext_seq_prod (const zstd_compression_parameters *parameters );
ARGUMENTS parameters The compression parameters to be... |
zstd_compress_bound(9) | NAME zstd_compress_bound - maximum compressed size in worst case scenario
SYNOPSIS size_t zstd_compress_bound (size_t src_size );
ARGUMENTS src_size The size of the data to compress.
RETURN The maximum compressed size in the worst case scenario.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_is_error(9),... |
zstd_compress_cctx(9) | NAME zstd_compress_cctx - compress src into dst with the initialized parameters
SYNOPSIS size_t zstd_compress_cctx (zstd_cctx *cctx , void *dst , size_t dst_capacity , const void *src , size_t src_size , const zstd_parameters *parameters );
ARGUMENTS cctx The context. Must have been initialized with zstd_init_... |
zstd_compress_sequences_and_literals(9) | NAME zstd_compress_sequences_and_literals - compress an array of zstd_sequence and literals
SYNOPSIS size_t zstd_compress_sequences_and_literals (zstd_cctx *cctx , void* dst , size_t dst_capacity , const zstd_sequence *in_seqs , size_t in_seqs_size , const void* literals , size_t lit_size , size_t lit_capacity , siz... |
zstd_compress_stream(9) | NAME zstd_compress_stream - streaming compress some of input into output
SYNOPSIS size_t zstd_compress_stream (zstd_cstream *cstream , zstd_out_buffer *output , zstd_in_buffer *input );
ARGUMENTS cstream The zstd streaming compression context.
output Destination buffer. `output->pos` is updated to in... |
zstd_compress_using_cdict(9) | NAME zstd_compress_using_cdict - compress src into dst using a dictionary
SYNOPSIS size_t zstd_compress_using_cdict (zstd_cctx *cctx , void *dst , size_t dst_capacity , const void *src , size_t src_size , const zstd_cdict *cdict );
ARGUMENTS cctx The context. Must have been initialized with zstd_init_cctx.
... |
zstd_create_cctx_advanced(9) | NAME zstd_create_cctx_advanced - Create compression context
SYNOPSIS zstd_cctx * zstd_create_cctx_advanced (zstd_custom_mem custom_mem );
ARGUMENTS custom_mem Custom allocator.
RETURN NULL on error, pointer to compression context otherwise.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), ... |
zstd_create_cdict_byreference(9) | NAME zstd_create_cdict_byreference - Create compression dictionary
SYNOPSIS zstd_cdict * zstd_create_cdict_byreference (const void *dict , size_t dict_size , zstd_compression_parameters cparams , zstd_custom_mem custom_mem );
ARGUMENTS dict Pointer to dictionary buffer.
dict_size Size of the dictiona... |
zstd_create_dctx_advanced(9) | NAME zstd_create_dctx_advanced - Create decompression context
SYNOPSIS zstd_dctx * zstd_create_dctx_advanced (zstd_custom_mem custom_mem );
ARGUMENTS custom_mem Custom allocator.
RETURN NULL on error, pointer to decompression context otherwise.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(... |
zstd_create_ddict_byreference(9) | NAME zstd_create_ddict_byreference - Create decompression dictionary
SYNOPSIS zstd_ddict * zstd_create_ddict_byreference (const void *dict , size_t dict_size , zstd_custom_mem custom_mem );
ARGUMENTS dict Pointer to dictionary buffer.
dict_size Size of the dictionary buffer.
custom_mem Memor... |
zstd_cstream_workspace_bound(9) | NAME zstd_cstream_workspace_bound - memory needed to initialize a zstd_cstream
SYNOPSIS size_t zstd_cstream_workspace_bound (const zstd_compression_parameters *cparams );
ARGUMENTS cparams The compression parameters to be used for compression.
RETURN A lower bound on the size of the workspace that is passed to z... |
zstd_cstream_workspace_bound_with_ext_seq_prod(9) | NAME zstd_cstream_workspace_bound_with_ext_seq_prod - memory needed to initialize a zstd_cstream when using the block-level external sequence producer API.
SYNOPSIS size_t zstd_cstream_workspace_bound_with_ext_seq_prod (const zstd_compression_parameters *cparams );
ARGUMENTS cparams The compression parameters to ... |
zstd_dctx_workspace_bound(9) | NAME zstd_dctx_workspace_bound - max memory needed to initialize a zstd_dctx
SYNOPSIS size_t zstd_dctx_workspace_bound (void );
ARGUMENTS void no arguments
RETURN A lower bound on the size of the workspace that is passed to zstd_init_dctx.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound... |
zstd_decompress_dctx(9) | NAME zstd_decompress_dctx - decompress zstd compressed src into dst
SYNOPSIS size_t zstd_decompress_dctx (zstd_dctx *dctx , void *dst , size_t dst_capacity , const void *src , size_t src_size );
ARGUMENTS dctx The decompression context.
dst The buffer to decompress src into.
dst_capacit... |
zstd_decompress_stream(9) | NAME zstd_decompress_stream - streaming decompress some of input into output
SYNOPSIS size_t zstd_decompress_stream (zstd_dstream *dstream , zstd_out_buffer *output , zstd_in_buffer *input );
ARGUMENTS dstream The zstd streaming decompression context.
output Destination buffer. `output.pos` is update... |
zstd_decompress_using_ddict(9) | NAME zstd_decompress_using_ddict - decompress src into dst using a dictionary
SYNOPSIS size_t zstd_decompress_using_ddict (zstd_dctx *dctx , void *dst , size_t dst_capacity , const void *src , size_t src_size , const zstd_ddict *ddict );
ARGUMENTS dctx The decompression context.
dst The buffer ... |
zstd_default_clevel(9) | NAME zstd_default_clevel - default compression level
SYNOPSIS int zstd_default_clevel (void );
ARGUMENTS void no arguments
RETURN Default compression level.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_is_error(9), zstd_get_error_code(9), zstd_get_error_name(9), zstd_... |
zstd_dstream_workspace_bound(9) | NAME zstd_dstream_workspace_bound - memory needed to initialize a zstd_dstream
SYNOPSIS size_t zstd_dstream_workspace_bound (size_t max_window_size );
ARGUMENTS max_window_size The maximum window size allowed for compressed frames.
RETURN A lower bound on the size of the workspace that is passed to zstd_init_dstream... |
zstd_end_stream(9) | NAME zstd_end_stream - flush internal buffers into output and end the frame
SYNOPSIS size_t zstd_end_stream (zstd_cstream *cstream , zstd_out_buffer *output );
ARGUMENTS cstream The zstd streaming compression context.
output Destination buffer. `output->pos` is updated to indicate how much compressed... |
zstd_find_frame_compressed_size(9) | NAME zstd_find_frame_compressed_size - returns the size of a compressed frame
SYNOPSIS size_t zstd_find_frame_compressed_size (const void *src , size_t src_size );
ARGUMENTS src Source buffer. It should point to the start of a zstd encoded frame or a skippable frame.
src_size The size of the source... |
zstd_flush_stream(9) | NAME zstd_flush_stream - flush internal buffers into output
SYNOPSIS size_t zstd_flush_stream (zstd_cstream *cstream , zstd_out_buffer *output );
ARGUMENTS cstream The zstd streaming compression context.
output Destination buffer. `output->pos` is updated to indicate how much compressed data was writ... |
zstd_free_cctx(9) | NAME zstd_free_cctx - Free compression context
SYNOPSIS size_t zstd_free_cctx (zstd_cctx* cctx );
ARGUMENTS cctx -- undescribed --
RETURN Always 0.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_is_error(9), zstd_get_error_code(9), zstd_get_error_name(9), zstd_min_clevel(9... |
zstd_free_cdict(9) | NAME zstd_free_cdict - Free compression dictionary
SYNOPSIS size_t zstd_free_cdict (zstd_cdict* cdict );
ARGUMENTS cdict Pointer to compression dictionary.
RETURN Always 0.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_is_error(9), zstd_get_error_code(9), zstd_get_error_nam... |
zstd_free_dctx(9) | NAME zstd_free_dctx - - Free decompression context
SYNOPSIS size_t zstd_free_dctx (zstd_dctx *dctx );
ARGUMENTS dctx Pointer to decompression context.
RETURN Always 0.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_is_error(9), zstd_get_error_code(9), zstd_get_error_name(9)... |
zstd_free_ddict(9) | NAME zstd_free_ddict - Free decompression dictionary
SYNOPSIS size_t zstd_free_ddict (zstd_ddict *ddict );
ARGUMENTS ddict -- undescribed --
RETURN Always 0.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_is_error(9), zstd_get_error_code(9), zstd_get_error_name(9), zstd_min... |
zstd_get_cparams(9) | NAME zstd_get_cparams - returns zstd_compression_parameters for selected level
SYNOPSIS zstd_compression_parameters zstd_get_cparams (int level , unsigned long long estimated_src_size , size_t dict_size );
ARGUMENTS level The compression level
estimated_src_size
The estimated source s... |
zstd_get_error_code(9) | NAME zstd_get_error_code - translates an error function result to an error code
SYNOPSIS zstd_error_code zstd_get_error_code (size_t code );
ARGUMENTS code The function result for which zstd_is_error(code) is true.
RETURN A unique error code for this error.
SEE ALSO Kernel file ./include/linux/zstd.h z... |
zstd_get_error_name(9) | NAME zstd_get_error_name - translates an error function result to a string
SYNOPSIS const char * zstd_get_error_name (size_t code );
ARGUMENTS code The function result for which zstd_is_error(code) is true.
RETURN An error string corresponding to the error code.
SEE ALSO Kernel file ./include/linux/zstd.... |
zstd_get_frame_header(9) | NAME zstd_get_frame_header - extracts parameters from a zstd or skippable frame
SYNOPSIS size_t zstd_get_frame_header (zstd_frame_header *params , const void *src , size_t src_size );
ARGUMENTS params On success the frame parameters are written here.
src The source buffer. It must point to a zstd... |
zstd_get_params(9) | NAME zstd_get_params - returns zstd_parameters for selected level
SYNOPSIS zstd_parameters zstd_get_params (int level , unsigned long long estimated_src_size );
ARGUMENTS level The compression level
estimated_src_size
The estimated source size to compress or 0 if unknown.
RETURN The ... |
zstd_init_cctx(9) | NAME zstd_init_cctx - initialize a zstd compression context
SYNOPSIS zstd_cctx * zstd_init_cctx (void *workspace , size_t workspace_size );
ARGUMENTS workspace The workspace to emplace the context into. It must outlive the returned context.
workspace_size
The size of workspace. Use zstd_c... |
zstd_init_cstream(9) | NAME zstd_init_cstream - initialize a zstd streaming compression context @parameters The zstd parameters to use for compression.
SYNOPSIS zstd_cstream * zstd_init_cstream (const zstd_parameters *parameters , unsigned long long pledged_src_size , void *workspace , size_t workspace_size );
ARGUMENTS parameters -- unde... |
zstd_init_dctx(9) | NAME zstd_init_dctx - initialize a zstd decompression context
SYNOPSIS zstd_dctx * zstd_init_dctx (void *workspace , size_t workspace_size );
ARGUMENTS workspace The workspace to emplace the context into. It must outlive the returned context.
workspace_size
The size of workspace. Use zstd... |
zstd_init_dstream(9) | NAME zstd_init_dstream - initialize a zstd streaming decompression context
SYNOPSIS zstd_dstream * zstd_init_dstream (size_t max_window_size , void *workspace , size_t workspace_size );
ARGUMENTS max_window_size The maximum window size allowed for compressed frames.
workspace The workspace to emplace the co... |
zstd_is_error(9) | NAME zstd_is_error - tells if a size_t function result is an error code
SYNOPSIS unsigned int zstd_is_error (size_t code );
ARGUMENTS code The function result to check for error.
RETURN Non-zero iff the code is an error.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_get_error_code... |
zstd_max_clevel(9) | NAME zstd_max_clevel - maximum allowed compression level
SYNOPSIS int zstd_max_clevel (void );
ARGUMENTS void no arguments
RETURN The maximum allowed compression level.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_is_error(9), zstd_get_error_code(9), zstd_get_error_name(9)... |
zstd_min_clevel(9) | NAME zstd_min_clevel - minimum allowed compression level
SYNOPSIS int zstd_min_clevel (void );
ARGUMENTS void no arguments
RETURN The minimum allowed compression level.
SEE ALSO Kernel file ./include/linux/zstd.h zstd_compress_bound(9), zstd_is_error(9), zstd_get_error_code(9), zstd_get_error_name(9)... |
zstd_reset_cstream(9) | NAME zstd_reset_cstream - reset the context using parameters from creation
SYNOPSIS size_t zstd_reset_cstream (zstd_cstream *cstream , unsigned long long pledged_src_size );
ARGUMENTS cstream The zstd streaming compression context to reset.
pledged_src_size
Optionally the source size, o... |
zstd_reset_dstream(9) | NAME zstd_reset_dstream - reset the context using parameters from creation
SYNOPSIS size_t zstd_reset_dstream (zstd_dstream *dstream );
ARGUMENTS dstream The zstd streaming decompression context to reset.
DESCRIPTION Resets the context using the parameters from creation. Skips dictionary loading, since it can be... |
zstdcat(1) | NAME zstd - zstd, zstdmt, unzstd, zstdcat - Compress or decompress .zst files
SYNOPSIS zstd [OPTIONS] [-|INPUT-FILE] [-o OUTPUT-FILE]
zstdmt is equivalent to zstd -T0
unzstd is equivalent to zstd -d
zstdcat is equivalent to zstd -dcf
DESCRIPTION zstd is a fast lossless compression algorithm ... |
zstdgrep(1) | NAME zstdgrep - print lines matching a pattern in zstandard-compressed files
SYNOPSIS zstdgrep [grep-flags] [--] pattern [files ...]
DESCRIPTION zstdgrep runs grep(1) on files, or stdin if no files argument is given, after decompressing them with zstdcat(1).
The grep-flags and pattern arguments are passed on ... |
zstdless(1) | NAME zstdless - view zstandard-compressed files
SYNOPSIS zstdless [flags] [file ...]
DESCRIPTION zstdless runs less(1) on files or stdin, if no file argument is given, after decompressing them with zstdcat(1).
SEE ALSO zstd(1)
zstd 1.5.7 ... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.