core/builtins/gobble.cif
changeset 58 377ac716dabb
parent 0 7f656887cf89
equal deleted inserted replaced
57:683f4b1f08ce 58:377ac716dabb
    12 
    12 
    13 ==name gobble
    13 ==name gobble
    14 
    14 
    15 ==short-description
    15 ==short-description
    16 
    16 
    17 A tool for purposefully wasting persistent storage space.
    17 A tool for purposefully wasting disk space.
    18 
    18 
    19 ==long-description
    19 ==long-description
    20 
    20 
    21 If the specified file does not already exist, it will be created. If it does exist, it will be grown.
    21 If the specified file does not already exist, it will be created. If it does exist, it will be grown by the amount specified.
    22 
    22 
    23 ==see-also
    23 ==see-also
    24 
    24 
    25 L<leak|leak>
    25 L<leak|leak>
    26 
    26 
    27 ==option bool v verbose
    27 ==option bool v verbose
    28 
    28 
    29 Display more detailed output.
    29 Display more detailed output.
    30 
    30 
       
    31 ==option bool n no-write
       
    32 
       
    33 By default the file is filled with a pattern of 'x' characters. Specify this option to only set the file size and not to actually write to it. Useful if you want to test low disk space without introducing delays (and wear to the disk) of actually writing lots of data.
       
    34 
    31 ==argument filename file_name
    35 ==argument filename file_name
    32 
    36 
    33 The file to create or to append to.
    37 The file to create or to append to.
    34 
    38 
    35 ==argument uint amount
    39 ==argument uint amount optional
    36 
    40 
    37 The total number of bytes to consume.
    41 The total number of bytes to consume. If zero or not specified, the file size is set to fill the free space on the disk.
    38 
    42 
    39 ==argument uint block_size optional
    43 ==argument uint block_size optional
    40 
    44 
    41 The maximum size of each write (in bytes). Defaults to 512.
    45 The maximum size of each write (in bytes). Defaults to 512.
    42 
    46