Skip to content

Commit 534412d

Browse files
committed
add octave_tar dependency
1 parent 1f1a4c4 commit 534412d

File tree

5 files changed

+52
-3
lines changed

5 files changed

+52
-3
lines changed

CITATION

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
引用octave_zstd
2+
如果你在学术研究中涉及octave_zstd,那么可以按需引用以下内容。
3+
octave_zstd源码(BibTeX)
4+
@misc{CNOCTAVE2024, author = {Yu Hongbo, }, title = {octave_zstd}, year = {2024}, howpublished = {\url{https://github.com/CNOCTAVE/octave_zstd}}, }
5+
6+
octave_zstd文档(BibTeX)
7+
@techreport{CNOCTAVE2024, author = {Yu Hongbo, }, title = {octave_zstd Document}, institution = {BA DU XIN SHANG}, year = {2024}, number = {1}, month = {10}, url = {https://cnoctave.github.io/octave_zstd/index.html}, urldate = {2024-10-07}, }
8+
9+
octave_zstd: Efficient File and String Decompression Utilizing the ZSTD Algorithm(BibTeX)
10+
@article{https://doi.org/10.6084/m9.figshare.27186048.v1, doi = {10.6084/M9.FIGSHARE.27186048.V1}, url = {https://figshare.com/articles/preprint/octave_zstd_Efficient_File_and_String_Decompression_Utilizing_the_ZSTD_Algorithm/27186048/1}, author = {Yu Hongbo, }, keywords = {Software architecture}, title = {octave_zstd: Efficient File and String Decompression Utilizing the ZSTD Algorithm}, publisher = {figshare}, year = {2024}, copyright = {Creative Commons Attribution 4.0 International} }

PKG_ADD

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pkg load octave_tar

docs/index.html

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,14 @@
8282
项目首页
8383
</q-item-section>
8484
</q-item>
85+
<q-item clickable v-ripple @click="goToID('#repo_install')">
86+
<q-item-section avatar>
87+
<q-icon name="help" />
88+
</q-item-section>
89+
<q-item-section>
90+
软件源安装
91+
</q-item-section>
92+
</q-item>
8593
<q-item clickable v-ripple @click="goToID('#online_install')">
8694
<q-item-section avatar>
8795
<q-icon name="help" />
@@ -114,6 +122,14 @@
114122
依赖库
115123
</q-item-section>
116124
</q-item>
125+
<q-item clickable v-ripple @click="goToID('#dependencies-package')">
126+
<q-item-section avatar>
127+
<q-icon name="help" />
128+
</q-item-section>
129+
<q-item-section>
130+
依赖包
131+
</q-item-section>
132+
</q-item>
117133
<q-item clickable v-ripple @click="goToID('#function_usage')">
118134
<q-item-section avatar>
119135
<q-icon name="help" />
@@ -155,6 +171,11 @@
155171
<q-btn id="homepage" class="title1 text-white bg-primary" stretch flat
156172
label="项目首页:https://github.com/CNOCTAVE/octave_zstd" @click="goTo('https://github.com/CNOCTAVE/octave_zstd')"></q-btn>
157173
<q-separator></q-separator>
174+
<div id="repo_install" class="title1 q-ma-md text-primary">软件源安装</div>
175+
<p class="q-ma-md">octave_zstd可以通过Octave软件源安装。</p>
176+
<div class="text-h5 q-ma-md text-red-10">通过Octave软件源安装octave_zstd,代码如下:</div>
177+
<p class="q-ma-md">>> pkg install -forge octave_zstd</p>
178+
<q-separator></q-separator>
158179
<div id="online_install" class="title1 q-ma-md text-primary">在线安装</div>
159180
<p class="q-ma-md">octave_zstd可以在线安装。</p>
160181
<div class="text-h5 q-ma-md text-red-10">在线安装octave_zstd,代码如下:</div>
@@ -177,6 +198,13 @@
177198
<div class="text-h5 q-ma-md text-red-10">在其他的Linux发行版上的命令有所不同。欢迎广大开发者补充。
178199
</div>
179200
<q-separator></q-separator>
201+
<div id="dependencies-package" class="title1 q-ma-md text-primary">依赖包</div>
202+
<div class="text-h5 q-ma-md text-red-10">此软件包依赖octave_tar。</div>
203+
<div class="text-h5 q-ma-md text-red-10">安装octave_tar,代码如下:</div>
204+
<p class="q-ma-md">>> pkg install -forge octave_tar</p>
205+
<div class="text-h5 q-ma-md text-red-10">在其他的Linux发行版上的命令有所不同。欢迎广大开发者补充。
206+
</div>
207+
<q-separator></q-separator>
180208
<div id="function_usage" class="title1 q-ma-md text-primary">函数用法</div>
181209
<div class="text-h5 q-ma-md text-red-10">zstd_compress</div>
182210
<p class="q-ma-md">Loadable Function: 0 = zstd_compress(FILENAME, COMPRESSED_FILENAME)</p>
@@ -189,6 +217,16 @@
189217
<p class="q-ma-md">输入压缩文件名COMPRESSED_FILENAME和解压缩后的文件名</p>
190218
<p class="q-ma-md">DECOMPRESSED_FILENAME。总是返回0。</p>
191219
<q-separator></q-separator>
220+
<div class="text-h5 q-ma-md text-red-10">tar_zstd_compress</div>
221+
<p class="q-ma-md">Loadable Function: ret = tar_zstd_compress(SOURCE1, SOURCE2, ... , TAR_ZSTD_FILENAME)</p>
222+
<p class="q-ma-md">输入一个或多个文件或文件夹名SOURCE1, SOURCE2, ...和压缩后的文件名TAR_ZSTD_FILENAME。</p>
223+
<p class="q-ma-md">如果返回0,则代表压缩成功;否则代表压缩失败。</p>
224+
<q-separator></q-separator>
225+
<div class="text-h5 q-ma-md text-red-10">tar_zstd_decompress</div>
226+
<p class="q-ma-md">Loadable Function: 0 = tar_zstd_decompress(TAR_ZSTD_FILENAME, DESTINATION_DIR)</p>
227+
<p class="q-ma-md">输入压缩文件名TAR_ZSTD_FILENAME和解压缩后的文件名DESTINATION_DIR。</p>
228+
<p class="q-ma-md">如果返回0,则代表解压缩成功;否则代表解压缩失败。</p>
229+
<q-separator></q-separator>
192230
<div class="text-h5 q-ma-md text-red-10">zstd_compress_string</div>
193231
<p class="q-ma-md">Loadable Function: COMPRESSED_STRING = zstd_compress_string(STRING)</p>
194232
<p class="q-ma-md">输入字符串STRING,返回压缩后的字符串COMPRESSED_STRING。</p>

inst/tar_zstd_compress.m

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
## this program; if not, see <http://www.gnu.org/licenses/>.
1616

1717
## -*- texinfo -*-
18-
## @deftypefn {} {} tar_zstd_compress (@var{source1}, @var{source2}, @var{...} , @var{output_filename})
18+
## @deftypefn {} {} tar_zstd_compress (@var{source1}, @var{source2}, @var{...} , @var{tar_zstd_filename})
1919
## 将一个或多个文件或文件夹压缩为.tar.zst文件
2020
## @example
21-
## param: source1, source2, ... , output_filename
21+
## param: source1, source2, ... , tar_zstd_filename
2222
##
2323
## return: status
2424
## @end example

inst/tar_zstd_decompress.m

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
## this program; if not, see <http://www.gnu.org/licenses/>.
1616

1717
## -*- texinfo -*-
18-
## @deftypefn {} {} tar_zstd_decompress (@var{tar_filename}, @var{destination_dir})
18+
## @deftypefn {} {} tar_zstd_decompress (@var{tar_zstd_filename}, @var{destination_dir})
1919
## 将.tar.zst文件解压缩到目标目录下
2020
## @example
2121
## param: source1, source2, ... , output_filename

0 commit comments

Comments
 (0)